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

Naming conventions #470

Open
SolarDrew opened this issue May 22, 2018 · 3 comments
Open

Naming conventions #470

SolarDrew opened this issue May 22, 2018 · 3 comments
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org plasmapy.formulary Related to the plasmapy.formulary subpackage

Comments

@SolarDrew
Copy link
Contributor

I think we've mostly been sticking to the same names for things like electron/ion density, but I think there are a few places where we may not have done. I can't remember if we have defined conventions written down anywhere for this sort of thing, but if we don't we probably should, and then we should add those conventions (or a link to them) to the contributor guide.

@namurphy namurphy added docs PlasmaPy Docs at http://docs.plasmapy.org plasmapy.formulary Related to the plasmapy.formulary subpackage labels May 22, 2018
@lemmatum
Copy link
Contributor

lemmatum commented May 23, 2018

Perhaps a table of common plasma variables/properties in the docs? This would include the common name(s), the variable name we use, and a short description of what the property is/does.

@SolarDrew
Copy link
Contributor Author

Yes, I like that idea.

@namurphy
Copy link
Member

Yeah, I like all of these ideas! We should include the variable name we use in code and also the mathematical symbol that we use in equations in the documentation. We should also describe conventions for variable types in general, e.g., do we use f or 𝜈 for frequencies, 𝛺 or 𝜔 for angular frequencies, and so on with appropriate subscripts.

There are also multiple names for the same phenomena, like gyrofrequency vs. Larmor frequency. It would be confusing to use more than one name for things in the code base and documentation, but it would likely be helpful to list other names too in case someone does a search for them.

Cross-references: #176 and maybe #136, #273, #274, and #355.

@namurphy namurphy added this to the v0.3.0 milestone Oct 16, 2018
@JvPy JvPy mentioned this issue Dec 12, 2019
3 tasks
@rocco8773 rocco8773 moved this from To-Do to Icebox in Formulary Development Jul 9, 2020
@rocco8773 rocco8773 moved this from Icebox to Backlog in Formulary Development Jul 15, 2020
@rocco8773 rocco8773 moved this from Icebox to Backlog in Documentation Development Jul 15, 2020
@StanczakDominik StanczakDominik removed this from the v0.3.0 milestone Mar 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org plasmapy.formulary Related to the plasmapy.formulary subpackage
Projects
Development

No branches or pull requests

4 participants