Remove docs for fields not in the spec #408
Open
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.
I am a longtime phenopackets user and I lean heavily on the documentation page, so thanks for that. In honour of "phenopackets docs fest" I offer some documentation fixes that I hope will eliminate a lot of confusion... at least on my part.
The documentation has entries for several fields that are not part of any version of the specification. It seems like these fields were in development for phenopackets version 2, but then never adopted, or were adopted under a different name, but then the documentation was not updated accordingly.
This PR removes docs for the following fields, none of which exist in the schema:
Some but not all of these were orphaned in the sense that they could not be found by clicking through the readthedocs page, but all are returned by the search feature on the same page. So if you search for "exposure" you will be led to a page that falsely claims that Exposure is a top-level phenopackets field. I believe this has caused confusion among phenopackets users before.
I also removed this orphaned page, again discoverable only through search, that describes version 2 as in progress and contained the only references to these erroneous fields (except for StopReason, which is still listed as a building block).
For fields that were renamed or replaced, the correct documentation exists already under the appropriate name.
Resolves issue #395. Cheers!