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

Update VEP plugin documentation script #1050

Merged

Conversation

nuno-agostinho
Copy link
Contributor

@nuno-agostinho nuno-agostinho commented Nov 2, 2023

ENSVAR-5517: Requires Ensembl/VEP_plugins#674

Changelog

  • a83766f: Format bullet and numbered lists
    • Bullet lists are created for line starting with characters like - and *
    • Numbered lists are created for numbered patterns like 2. and 4)
    • Nested lists are not currently supported
  • 23c5c38: Display plugin arguments in a table
    • Arguments need to be in format argument_name : description
    • The table only starts after a sentence that contains the keyword key=value
  • 2228285: Add usage examples from SYNOPSIS
  • 6d2712e: Add code block when using ``` (like in Markdown)
  • 6e65ae3: Format text surrounded with ` or ' as keyboard input (<kbd>)
  • 2537dd5: Convert DOI (pattern like doi:10.235/343) to an URL
  • 97d2793: Increase list of UNIX commands automatically recognised for code blocks
  • 1cb91a2: Add anchor links to each plugin row

Bug fixes

  • 3522e55: Fix table layout
    • Code blocks are now scrollable instead of increasing table width
  • 0412c44: Avoid warning: Possible unintended interpolation of @: in string
  • 8c4fde2: Fix <p> tags
  • 3bc3609: Other minor bug fixes

Testing

Check the following features in my sandbox compared to the live website:

Feature Sandbox example
Numbered list Carol
Condel
Bullet list AlphaMissense
dbNSFP
Table of plugin arguments AlphaMissense
satMutMPRA
Usage examples AlphaMissense
Carol
Condel
Code block with ``` TranscriptAnnotator
neXtProt
Format text as <kbd> when surrounded with ` or ' AncestralAlle
Condel
DOI to URL Condel

Please check as many plugin docs as you can! Thank you.

@nuno-agostinho nuno-agostinho marked this pull request as ready for review January 4, 2024 13:20
@nakib103 nakib103 self-requested a review January 4, 2024 13:51
@nakib103 nakib103 self-assigned this Jan 4, 2024
Copy link
Contributor

@nakib103 nakib103 left a comment

Choose a reason for hiding this comment

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

Thanks nuno, the docs look better now!

@nakib103 nakib103 merged commit 258b326 into Ensembl:postreleasefix/112 Jan 5, 2024
1 check passed
@nakib103
Copy link
Contributor

nakib103 commented Jan 5, 2024

merged to release/112 and main

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants