Skip to content

Conversation

@pdurbin
Copy link
Member

@pdurbin pdurbin commented Feb 26, 2025

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:

@pdurbin pdurbin added Size: 0.5 A percentage of a sprint. 0.35 hours FY25 Sprint 17 FY25 Sprint 17 (2025-02-12 - 2025-02-26) labels Feb 26, 2025
@pdurbin pdurbin moved this to Ready for Review ⏩ in IQSS Dataverse Project Feb 26, 2025
@github-actions github-actions bot added DCM2025 hackathon proposed for community meeting hackathon Feature: API Guide good first issue appears at https://github.com/IQSS/dataverse/contribute hacktoberfest It's Hacktoberfest! https://groups.google.com/g/dataverse-community/c/n_Nn_T2yA-w/m/BcoXO4tEAQAJ Help Wanted: Documentation Type: Bug a defect labels Feb 26, 2025
@pdurbin pdurbin removed Type: Bug a defect Help Wanted: Documentation hacktoberfest It's Hacktoberfest! https://groups.google.com/g/dataverse-community/c/n_Nn_T2yA-w/m/BcoXO4tEAQAJ good first issue appears at https://github.com/IQSS/dataverse/contribute DCM2025 hackathon proposed for community meeting hackathon labels Feb 26, 2025
@cmbz cmbz added this to the 6.7 milestone Feb 26, 2025
@cmbz cmbz added the FY25 Sprint 18 FY25 Sprint 18 (2025-02-26 - 2025-03-12) label Feb 27, 2025
@github-project-automation github-project-automation bot moved this from Ready for Review ⏩ to Ready for QA ⏩ in IQSS Dataverse Project Mar 5, 2025
@ofahimIQSS
Copy link
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
@pdurbin pdurbin mentioned this pull request Mar 7, 2025
@pdurbin pdurbin requested a review from qqmyers March 7, 2025 16:37
@pdurbin
Copy link
Member Author

pdurbin commented Mar 7, 2025

Merge conflicts resolved but @qqmyers might want to take a look. I fixed the docs he recently added in this PR:

@coveralls
Copy link

Coverage Status

coverage: 22.684%. remained the same
when pulling 03e6617 on 10257-get-citation
into 366d7ac on develop.

@cmbz cmbz added the FY25 Sprint 19 FY25 Sprint 19 (2025-03-12 - 2025-03-26) label Mar 12, 2025
@stevenwinship stevenwinship self-assigned this Mar 19, 2025
@stevenwinship stevenwinship moved this from Ready for QA ⏩ to QA ✅ in IQSS Dataverse Project Mar 19, 2025
@stevenwinship
Copy link
Contributor

Tested all modified curl command in the doc. All passed

@stevenwinship stevenwinship reopened this Mar 19, 2025
@stevenwinship stevenwinship merged commit 6bf262f into develop Mar 19, 2025
17 of 18 checks passed
@github-project-automation github-project-automation bot moved this from QA ✅ to Merged 🚀 in IQSS Dataverse Project Mar 19, 2025
@stevenwinship stevenwinship removed their assignment Mar 19, 2025
@scolapasta scolapasta moved this from Merged 🚀 to Done 🧹 in IQSS Dataverse Project Mar 19, 2025
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

Projects

Status: Done 🧹

Development

Successfully merging this pull request may close these issues.

API Guide: Typo in "get citation for dataset" API docs

8 participants