Improve documentation for obsoletion#2718
Conversation
Closes OBOFoundry#2717 Adjust numbering, indenting and newlines; add allowed values for obsolescence reason
| |obo:IAO_0000227|IAO:0000227|terms merged |???|An editor note should explain what were the merged terms and the reason for the merge. | | ||
| |obo:IAO_0000228|IAO:0000228|term imported|???|This is to be used when the original term has been replaced by a term imported from an other ontology. An editor note should indicate what is the URI of the new term to use.| | ||
| |obo:IAO_0000229|IAO:0000229|term split |???|This is to be used when a term has been split in two or more new terms. An editor note should indicate the reason for the split and indicate the URIs of the new terms created.| | ||
| |obo:OMO_0001000|OMO:0001000|out of scope |???|This obsolesence reason should be used conservatively. Typical valid examples are: un-necessary grouping classes in disease ontologies, a phenotype term added on the assumption it was a disease.| |
There was a problem hiding this comment.
While this is highly useful--and we agree it should be documented--we don't believe it should be on this principles page since it is more detailed than we'd like. There is a page (the OBO Academy "O-book" on obsoletion) that we already reference under Implementation (first sentence below that heading) which is intended to provide such details. We will look into having this information added there and, once done, will highlight that page again under the section mentioning the obsolescence reasons. We see that the same request was made under the ontology-metadata repo, so the information won't be lost. We thus ask that the table above be removed from your suggested changes.
There was a problem hiding this comment.
Fine. Implemented in OBOAcademy/obook#546
|
@Zack-83 Thank you very much for your input! The html rendering is now fixed. |
Unfortunately that was not enough yet:
I added a further commit: Zack-83@f4f401e Maybe that does the job. @nataled Maybe you can reopen the PR and execute it again, or cherry-pick the last edit |
|
@Zack-83 it took quite a few tries, but I think we finally have the formatting correct! Thank you again for all your input. |
2 participants
Closes #2717
Adjust numbering, indenting and newlines; add allowed values for obsolescence reason