-
Notifications
You must be signed in to change notification settings - Fork 531
Get Citation API docs: fix typo, link to version spec #11290
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
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sekmiller
approved these changes
Mar 5, 2025
Contributor
|
reviewed PR - looks good. Will merge once branch conflict is resolved. |
Conflicts: doc/sphinx-guides/source/api/native-api.rst Fix repeated "version" in path introduced in #11163
Merged
Member
Author
|
Merge conflicts resolved but @qqmyers might want to take a look. I fixed the docs he recently added in this PR: |
qqmyers
approved these changes
Mar 7, 2025
Contributor
|
Tested all modified curl command in the doc. All passed |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Feature: API Guide
FY25 Sprint 17
FY25 Sprint 17 (2025-02-12 - 2025-02-26)
FY25 Sprint 18
FY25 Sprint 18 (2025-02-26 - 2025-03-12)
FY25 Sprint 19
FY25 Sprint 19 (2025-03-12 - 2025-03-26)
Size: 0.5
A percentage of a sprint. 0.35 hours
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
There's a typo in the "Get Citation" and "Get Citation In Other Formats" API docs (duplicate "version").
Plus, while I was in there, I linked to the "how to specify versions" section, as suggested by @DS-INRAE (thanks).
Which issue(s) this PR closes:
Special notes for your reviewer:
None.
Suggestions on how to test this:
Try the API.
Look for typos.
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
No.
Is there a release notes update needed for this change?:
I didn't bother.
Additional documentation: