Improve consistency and ReST formatting in documentation #1073

namurphy · 2021-03-13T21:49:11Z

Some minor touch-ups and updates to the documentation, including to the stability matrix. The changes should be pretty straightforward.

codecov · 2021-03-13T21:51:14Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.95%. Comparing base (8036945) to head (edf6a0f).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1073      +/-   ##
==========================================
- Coverage   96.95%   96.95%   -0.01%     
==========================================
  Files          71       71              
  Lines        7027     7026       -1     
==========================================
- Hits         6813     6812       -1     
  Misses        214      214

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

docs/about/stability.rst

docs/install.rst

I started to implement `ParticleLike` in some docstrings, and decided that went outside the scope of this pull request.

namurphy · 2021-03-14T01:23:39Z

This PR includes an update to the section in the docs on required packages, so it'd be helpful (but not required) for this to be merged before the 0.6.0 release.

docs/install.rst

rocco8773 · 2021-04-30T03:48:38Z

plasmapy/plasma/grids.py

@@ -348,7 +342,7 @@ def unit(self):

        Raises
        ------
-        ValueError
+        `ValueError`


I'm totally okay with this. Just pointing out that it makes no difference when rendering the RTD docs. For some reason, the numpydoc "Raises" section never applies the code syntax when this is done.

rocco8773

In the grids module, all instances of DataArray should be replaced with ~xarray.DataArray so it's properly cross-referenced. This will also require adding xarray to the intersphinx_mapping dictionary in the conf.py.

Co-authored-by: Erik Everson <[email protected]>

docs/particles/ionization_states.rst

…the-next-generation

plasmapy/particles/ionization_state_collection.py

Co-authored-by: Erik Everson <[email protected]>

…lasmaPy into doc-fixes-the-next-generation

namurphy · 2021-05-17T23:29:22Z

There are probably conflicts between this PR and #1136. It's probably most sensible to merge #1136 first, and then do the next round of reviews after I resolve the conflicts.

…the-next-generation

rocco8773

LGTM

namurphy · 2021-05-20T01:45:45Z

LGTM

Thanks! The most recent set of changes are expanding the links (mostly ~plasmapy.particles.ParticleClass to ~plasmapy.particles.particle_class.Particle, etc.) and making sure lines aren't too long. I'm going to take one last careful look.

rocco8773

Still looks good. :)

…the-next-generation

Update stability matrix

d0c4feb

namurphy added the docs PlasmaPy Docs at http://docs.plasmapy.org label Mar 13, 2021

namurphy added 2 commits March 13, 2021 17:15

Update funding acknowledgments

830a371

Update main installation page in docs

1a59d9f

namurphy commented Mar 13, 2021

View reviewed changes

docs/about/stability.rst Outdated Show resolved Hide resolved

namurphy commented Mar 13, 2021

View reviewed changes

docs/install.rst Outdated Show resolved Hide resolved

namurphy added 15 commits March 13, 2021 19:32

Update docstrings in plasmapy.utils.roman

ed2f0a2

Update docstrings in plasmapy.plasma.sources.plasmablob

56a24a4

Update docstrings in plasmapy.plasma.sources.plasma3d

c119b69

Update docstrings in plasmapy.simulation.particletracker

2396000

Update docstrings in plasmapy.simulation.particle_integrators

0556342

Update docstrings in optional_deps.py

dcaaf95

Update docstrings in narrative docs for particle class

90e3787

Update docstrings in openpmd_hdf5.py

5ce72a3

Update narrative documentation for ionization states

6a81290

Update docstrings for plasmapy.plasma.grids

ca90fcf

Update docstrings for plasmapy.plasma.exceptions

cf3a677

Update docstrings for plasmapy.utils.datatype_factory_base

8945a8e

Update docstrings for plasmapy.utils.code_repr

a87bca9

Update docstrings for plasmapy.simulation.abstractions

f38ba94

Update docstrings and annotations for plasmapy.particles.atomic

3678932

namurphy marked this pull request as ready for review March 14, 2021 01:03

namurphy added 3 commits March 13, 2021 20:04

Revert changes in atomic.py

a7dbf8c

I started to implement `ParticleLike` in some docstrings, and decided that went outside the scope of this pull request.

Simplify stability matrix entry for particles

5d66c3a

Update changelog

873fec5

rocco8773 reviewed Mar 14, 2021

View reviewed changes

docs/install.rst Outdated Show resolved Hide resolved

rocco8773 reviewed Mar 14, 2021

View reviewed changes

docs/install.rst Outdated Show resolved Hide resolved

rocco8773 reviewed Mar 14, 2021

View reviewed changes

docs/install.rst Outdated Show resolved Hide resolved

rocco8773 reviewed Apr 30, 2021

View reviewed changes

namurphy and others added 2 commits April 30, 2021 10:00

Apply suggestions from code review

3f1ef4a

Co-authored-by: Erik Everson <[email protected]>

Apply suggestions from code review

1e295fe

Co-authored-by: Erik Everson <[email protected]>

rocco8773 reviewed Apr 30, 2021

View reviewed changes

docs/particles/ionization_states.rst Outdated Show resolved Hide resolved

StanczakDominik and others added 2 commits May 14, 2021 16:32

Merge branch 'master' into doc-fixes-the-next-generation

ba3cfad

Merge branch 'master' of github.com:PlasmaPy/PlasmaPy into doc-fixes-…

8cc7da7

…the-next-generation

namurphy commented May 17, 2021

View reviewed changes

plasmapy/particles/ionization_state_collection.py Outdated Show resolved Hide resolved

namurphy and others added 3 commits May 17, 2021 19:08

Apply suggestions from code review

0ed09c4

Co-authored-by: Erik Everson <[email protected]>

Update docstring for tol attribute

ff644ac

Merge branch 'doc-fixes-the-next-generation' of github.com:namurphy/P…

f2e1678

…lasmaPy into doc-fixes-the-next-generation

rocco8773 mentioned this pull request May 18, 2021

Rename integer charge to charge number #1136

Merged

Merge branch 'master' of github.com:PlasmaPy/PlasmaPy into doc-fixes-…

b80ba09

…the-next-generation

rocco8773 approved these changes May 20, 2021

View reviewed changes

namurphy added 5 commits May 19, 2021 21:41

Expand ReST links in atomic.py

5294d2b

Expand ReST links in decorators.py

53f0ac7

Expand ReST links in ionization_state.py

a3f9507

Expand ReST links in nuclear.py

e76f1a6

Expand ReST links in particle_class.py

0f87a66

rocco8773 approved these changes May 20, 2021

View reviewed changes

namurphy added 5 commits May 19, 2021 22:10

Expand ReST links in particle_collections.py

64c9aeb

PEP8ify line lengths in docs

d1ce752

Minor doc cleanup + some ReST links

30d3ae4

Merge branch 'master' of github.com:PlasmaPy/PlasmaPy into doc-fixes-…

f33775e

…the-next-generation

Fix typo

edf6a0f

namurphy enabled auto-merge (squash) May 20, 2021 02:24

namurphy merged commit d64c10c into PlasmaPy:master May 20, 2021

namurphy deleted the doc-fixes-the-next-generation branch May 20, 2021 02:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve consistency and ReST formatting in documentation #1073

Improve consistency and ReST formatting in documentation #1073

namurphy commented Mar 13, 2021

codecov bot commented Mar 13, 2021 •

edited

Loading

namurphy commented Mar 14, 2021

rocco8773 Apr 30, 2021

rocco8773 left a comment

namurphy commented May 17, 2021

rocco8773 left a comment

namurphy commented May 20, 2021

rocco8773 left a comment

Improve consistency and ReST formatting in documentation #1073

Improve consistency and ReST formatting in documentation #1073

Conversation

namurphy commented Mar 13, 2021

codecov bot commented Mar 13, 2021 • edited Loading

Codecov Report

namurphy commented Mar 14, 2021

rocco8773 Apr 30, 2021

Choose a reason for hiding this comment

rocco8773 left a comment

Choose a reason for hiding this comment

namurphy commented May 17, 2021

rocco8773 left a comment

Choose a reason for hiding this comment

namurphy commented May 20, 2021

rocco8773 left a comment

Choose a reason for hiding this comment

codecov bot commented Mar 13, 2021 •

edited

Loading