Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change Procedure rst docs to match what is in the protobuf #382

Open
cmungall opened this issue Apr 4, 2024 · 0 comments · May be fixed by #383
Open

Change Procedure rst docs to match what is in the protobuf #382

cmungall opened this issue Apr 4, 2024 · 0 comments · May be fixed by #383

Comments

@cmungall
Copy link
Member

cmungall commented Apr 4, 2024

On https://phenopacket-schema.readthedocs.io/en/latest/procedure.html

The Procedure element represents a clinical procedure performed on a subject. For example a surgical or diagnostic procedure such as a biopsy.

If the Procedure element is used, it must contain a code element, but only need contain the body_site element if needed.

This is hard to interpret. It only need to do it if needed? What is this saying?

The protobuf documentation is IMO much clearer:

// A clinical procedure performed on a subject. By preference a single concept to indicate both the procedure and the
// body site should be used. In cases where this is not possible, the body site should be indicated using a separate
// ontology class.

I suggest manually syncing the rst with the protobuf to reflect what is in the latter

(perhaps future versions phenopackets will use linkml which solves this manual linking problem...)

cmungall added a commit that referenced this issue Apr 4, 2024
@cmungall cmungall linked a pull request Apr 4, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant