Clean up isDeprecated values #1864
Conversation
Merge pull request spdx#1862 from BassCoder2808/main
There was a problem hiding this comment.
Thanks @BassCoder2808! I have a couple of comments, please take a look.
@goneall Feel free to weigh in if you would like. Otherwise, this looks good to me once @BassCoder2808 makes the requested changes.
DOCS/xml-fields.md
Outdated
| @@ -44,17 +44,19 @@ Within the .xml file, the first and last lines of the file should be the followi | |||
| The main tag used to define the license or exception is, unsurprisingly, **`<license>`** or **`<exception>`**. All of the remaining content will be enclosed within a `<license></license>` or `<exception></exception>` pair of tags. | |||
|
|
|||
| There are two mandatory attributes for every `<license>` and `<exception>` tag: | |||
| * `licenseId`: the unique SPDX Identifier for the license; should be identical to the filename | |||
There was a problem hiding this comment.
Throughout this PR, it looks like in addition to removing the isDeprecated documentation, this PR is also changing all of the bullet types from * to -.
Are these changes needed, since both bullet types are valid for Markdown lists on GitHub?
If not needed, could you please revise the PR so that the only change is removing the isDeprecated documentation? Would prefer to keep the edits limited so that it's clear what's being changed here.
DOCS/xml-fields.md
Outdated
|
|
||
| - `isOsiApproved` (for licenses, not exceptions): either "true" or "false" based on whether this license has been approved by the [Open Source Initiative](https://opensource.org/licenses/alphabetical) | ||
| - `listVersionAdded`: in which release version of the SPDX License List was the license first added, e.g. "3.19". | ||
| - Typically you'll check the currently-released version at https://spdx.org/licenses/ and increment the minor version by 1 for a new license. | ||
|
|
||
| Finally, if the license ID has been deprecated, two additional attributes should be included: |
There was a problem hiding this comment.
Note that this line should also be changed to reference "one additional attribute" instead of "two additional attributes"
Fixes #1545
Removed the
isDeprecatedattribute from theXML Schema Definitionfile.xml-fields.mdcontainsisDeprecateddefinition which was also removed now.