There are a number of aliases accepted by Particle. For example, an alpha particle can be represented by "alpha" or even "α". These are only documented in the code as private variables for case sensitive or case insensitive aliases, but should be added as a table to the narrative documentation for completeness. The table in the docs should be generated from the private variables in plasmapy/particles/parsing.py since the aliases are going to be updated from time to time.
My usual strategy for dealing with dynamically created tables in reStructuredText has been to ignore it and hoping it would go away, but we might be able to look at https://github.com/astropy/astropy/pull/11618. There will probably be other times where we want to create tables, so it'd be helpful to make the code general (and documented) enough that we would be able to make use of it for other cases in the future.
There are a number of aliases accepted by
Particle
. For example, an alpha particle can be represented by"alpha"
or even"α"
. These are only documented in the code as private variables for case sensitive or case insensitive aliases, but should be added as a table to the narrative documentation for completeness. The table in the docs should be generated from the private variables inplasmapy/particles/parsing.py
since the aliases are going to be updated from time to time.My usual strategy for dealing with dynamically created tables in reStructuredText has been to ignore it and hoping it would go away, but we might be able to look at https://github.com/astropy/astropy/pull/11618. There will probably be other times where we want to create tables, so it'd be helpful to make the code general (and documented) enough that we would be able to make use of it for other cases in the future.