Improve id/DOI documentation #1078
Open
Conversation
This file contains 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
|
Thanks @Rafnuss! @peterdesmet WDYT? Is it not breaking? |
peterdesmet
requested changes
Jan 29, 2025
There was a problem hiding this comment.
This is none-breaking and a good suggestion.
@roll I suggested two changes:
- Can you accept these?
- For the second change, I didn't know at how many characters the text should wrap.
| @@ -16,13 +16,13 @@ name: | |||
| id: | |||
| title: ID | |||
| description: A property reserved for globally unique identifiers. Examples of | |||
| identifiers that are unique include UUIDs and DOIs. | |||
| identifiers that are unique include UUIDs and DOI links. | |||
There was a problem hiding this comment.
Suggested change
| identifiers that are unique include UUIDs and DOI links. | |
| identifiers that are unique include UUIDs and DOIs. |
Reverting this one, it is fine to just call it DOIs here.
| context: A common usage pattern for Data Packages is as a packaging format within | ||
| the bounds of a system or platform. In these cases, a unique identifier for | ||
| a package is desired for common data handling workflows, such as updating an | ||
| existing package. While at the level of the specification, global uniqueness | ||
| cannot be validated, consumers using the `id` property `MUST` ensure identifiers | ||
| are globally unique. | ||
| are globally unique. When using a DOI, specify the full DOI link. |
There was a problem hiding this comment.
Suggested change
| are globally unique. When using a DOI, specify the full DOI link. | |
| are globally unique. When providing a DOI, it is `RECOMMENDED` to provide the full URL (e.g. `https://doi.org/10.5281/zenodo.10053903`). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Refine the documentation to specify the DOI format for
id