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

Draft: Minor fixes to the documentation #796

Draft
wants to merge 20 commits into
base: master
Choose a base branch
from

Conversation

ustervbo
Copy link
Contributor

@ustervbo ustervbo commented Jul 16, 2024

This pull request includes several minor updates to the documentation. The changes are single word or minor modification of individual paragraphs to make statements more time oblivious - for instance, a paper from 2017 is not recently published.

Changes are (in semi-random order)

  • Modify copyright in conf.py to always include the current year
  • Update opening paragraph in
    • miairr_ncbi_overview.rst
    • introduction_miairr.rst

Changed the format of the links in the 'Tutorials, examples and workflows' section from toctree to bullet points to keep the style of the page.
Updated the copyright year in the Sphinx `conf.py` file to be dynamic.
I just think it looks better
It is clear from the context what the introduction is about
@ustervbo ustervbo added this to the AIRR 2.0 milestone Jul 16, 2024
@ustervbo ustervbo changed the title Draft: Minor fixes Draft: Minor fixes to the documentation Jul 16, 2024
@javh
Copy link
Contributor

javh commented Aug 12, 2024

Is this draft ready to be merged in or should we wait?

@ustervbo
Copy link
Contributor Author

We should wait.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: To do
Development

Successfully merging this pull request may close these issues.

2 participants