Skip to content

docs: Minor README fixes #20

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

Merged
merged 3 commits into from
Mar 27, 2025
Merged

docs: Minor README fixes #20

merged 3 commits into from
Mar 27, 2025

Conversation

jwm4
Copy link
Contributor

@jwm4 jwm4 commented Mar 26, 2025

Some small tweaks here:

  1. The README was referring to the project ID for watsonx.ai as an "instance ID" which seemed confusing so I changed it to project ID.
  2. The README omitted the URL for watsonx.ai. Maybe that's fine because lots of people use US South but some people don't use US South so I think it's nicer to just make it explicit that this is an optional parameter that defaults to the US South URL.
  3. Made the arguments to the generate_from_sample and critique a Path instead of a string. I think it would be nice if these methods took a string, but when I tried it, it seems like it only takes a Path

Signed-off-by: Bill Murdock <[email protected]>
Copy link

mergify bot commented Mar 26, 2025

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 Enforce conventional commit

Wonderful, this rule succeeded.

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert)(?:\(.+\))?(!)?:

Copy link
Collaborator

@ceberam ceberam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ceberam ceberam added the documentation Improvements or additions to documentation label Mar 26, 2025
@jwm4 jwm4 changed the title fix: Minor README fixes docs: Minor README fixes Mar 27, 2025
@jwm4
Copy link
Contributor Author

jwm4 commented Mar 27, 2025

Thanks! I have made these changes.

Copy link
Collaborator

@ceberam ceberam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @jwm4 for your contribution.
For next PRs, please consider rebasing your branch to main instead of creating a merge commit to keep the git log simpler.

@ceberam ceberam merged commit f892765 into docling-project:main Mar 27, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants