-
Notifications
You must be signed in to change notification settings - Fork 2
Update installation instructions for Docling #122
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Conversation
Added instructions to verify Docling installation. Signed-off-by: SuryaGanesh284 <surya285888@gmail.com>
Summary of ChangesHello @SuryaGanesh284, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request improves the Docling installation documentation by adding a verification step. This enhancement helps users confirm successful installation, troubleshoot potential issues, and gain confidence in their setup before proceeding with using the tool. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request adds a verification step to the installation instructions, which is a great improvement for user experience. However, I've identified a formatting issue in the markdown that would cause rendering problems, and the provided verification command is incorrect and would result in an error. My review includes a single, comprehensive suggestion to fix both the markdown structure and the command, recommending the use of the more standard docling --version.
| pip install docling | ||
|
|
||
| To verify that Docling was installed successfully, you can check the version: | ||
|
|
||
| ```bash | ||
| python -c "import docling; print(docling.__version__)" | ||
| ``` | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a formatting issue here that causes the explanatory text to be rendered as part of a code block. Additionally, the proposed command to verify the installation is incorrect and will raise an AttributeError because docling.__version__ is not defined.
A better approach is to use the docling --version command, which is the standard way to check the version of a CLI tool. This is both simpler for the user and correctly fetches the version information.
Here is a suggestion that fixes both the formatting and the command:
| pip install docling | |
| To verify that Docling was installed successfully, you can check the version: | |
| ```bash | |
| python -c "import docling; print(docling.__version__)" | |
| ``` | |
| ``` | |
| pip install docling |
To verify that Docling was installed successfully, you can check the version:
docling --version
Summary
Added installation verification instructions to help users confirm Docling was installed successfully.
Changes
Why this change?
Installation verification is a common best practice in documentation that helps users:
This is a minor documentation improvement with no code changes.