Visitar URL original
Add tables of contents to pages in contributor guide by namurphy · Pull Request #1662 · PlasmaPy/PlasmaPy · GitHub
Skip to content

Add tables of contents to pages in contributor guide - #1662

Merged
namurphy merged 5 commits into
PlasmaPy:mainfrom
namurphy:contrib-guide-toctrees
Aug 11, 2022
Merged

namurphy merged 5 commits into
PlasmaPy:mainfrom
namurphy:contrib-guide-toctrees

Conversation

@namurphy

@namurphy namurphy commented Aug 4, 2022

Copy link
Copy Markdown
Member

Following this comment, I'm adding tables of contents to most of the pages in the contributor guide.

I'm still playing around with where to place the tables of contents. I'm wondering about either right at the top, or after the preamble text.

@namurphy namurphy added the no changelog entry needed For PRs that should not have a changelog entry label Aug 4, 2022
@github-actions github-actions Bot added the docs PlasmaPy Docs at http://docs.plasmapy.org label Aug 4, 2022
@codecov

codecov Bot commented Aug 4, 2022 •

Copy link
Copy Markdown

Codecov Report

Merging #1662 (be3f290) into main (5a51592) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1662   +/-   ##
=======================================
  Coverage   97.23%   97.23%           
=======================================
  Files          84       84           
  Lines        8016     8016           
=======================================
  Hits         7794     7794           
  Misses        222      222           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@namurphy
namurphy marked this pull request as ready for review August 10, 2022 22:00
:backlinks: none

Introduction
------------

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Using --------- instead of ======== to match the style in the rest of this particular doc.

@namurphy namurphy added status: ready for review PRs that are ready for code review and removed status: in progress labels Aug 10, 2022
@namurphy
namurphy requested a review from a team August 10, 2022 22:02

@rocco8773 rocco8773 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM! Thanks for adding these.

@namurphy
namurphy merged commit 63d2066 into PlasmaPy:main Aug 11, 2022
@namurphy
namurphy deleted the contrib-guide-toctrees branch August 11, 2022 19:58
@namurphy namurphy removed the status: ready for review PRs that are ready for code review label Aug 15, 2022
@namurphy namurphy mentioned this pull request Aug 18, 2022
4 of 8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contributor guide docs PlasmaPy Docs at http://docs.plasmapy.org no changelog entry needed For PRs that should not have a changelog entry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants