Skip to content

Highlight negative examples as such. #228

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

Merged
merged 1 commit into from
Mar 27, 2025
Merged

Highlight negative examples as such. #228

merged 1 commit into from
Mar 27, 2025

Conversation

ifokkema
Copy link
Collaborator

The HGVS nomenclature website uses negative examples to show what not to do. These examples are almost always labeled as invalid, so they are rendered in red, indicating visually to the reader that these variant descriptions are invalid.

A recent analysis showed 89 invalid DNA descriptions on the HGVS website that were not labeled as invalid. This fixes those descriptions that are (IMO) clearly invalid examples, by labeling them as invalid examples. The descriptions themselves are not edited.

@ifokkema ifokkema added the documentation fix Correction to the documentation, like fixed typos label Mar 25, 2025
Copy link
Collaborator

@jfjlaros jfjlaros left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although I do not agree with the term "invalid", the labeling seems to be consistently applied to non-canonical descriptions.

Copy link
Collaborator

@reece reece left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great to me. Thanks for attending to these, @ifokkema !

@reece reece merged commit daddf1b into main Mar 27, 2025
1 check passed
@reece reece deleted the fix-negative-examples branch March 27, 2025 01:22
@ifokkema
Copy link
Collaborator Author

Thanks for reviewing @jfjlaros and @reece, and merging!
But would it be possible to use a simple merge? Or perhaps let the author of the PR decide how the PR should be merged? The squash-and-merge disturbs my workflow quite a bit... Besides my commit history being lost, it also requires me to force-delete my local branch which requires me to double-check things. Maybe we can come up with a standard workflow and add it to the dev docs?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation fix Correction to the documentation, like fixed typos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants