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

Add docstrings to functions in braginskii.py #410

Open
6 tasks
namurphy opened this issue Apr 27, 2018 · 3 comments
Open
6 tasks

Add docstrings to functions in braginskii.py #410

namurphy opened this issue Apr 27, 2018 · 3 comments
Assignees
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org needs docstring See: https://docs.plasmapy.org/en/latest/contributing/doc_guide.html#docstrings for more info needs subject matter expert Requires expertise from a plasma science domain expert priority: low Issues & PRs of low urgency and importance that may be deferred until later transport Related to plasma transport phenomena

Comments

@namurphy
Copy link
Member

namurphy commented Apr 27, 2018

There are several functions in braginskii.py that require docstrings, including:

  • resistivity
  • thermoelectric_conductivity
  • ion_thermal_conductivity
  • electron_thermal_conductivity
  • ion_viscosity
  • electron_viscosity

This is different from but very related to #308, which requests docstring improvements for methods/attributes of the ClassicalTransport class.

@namurphy namurphy added needs docstring See: https://docs.plasmapy.org/en/latest/contributing/doc_guide.html#docstrings for more info transport Related to plasma transport phenomena labels Apr 27, 2018
@namurphy namurphy added this to the v0.2 milestone Apr 27, 2018
@namurphy namurphy added the docs PlasmaPy Docs at http://docs.plasmapy.org label Apr 27, 2018
namurphy added a commit to lemmatum/PlasmaPy that referenced this issue Apr 27, 2018
@namurphy namurphy added the priority: high Issues & PRs with significant urgency and importance that should be addressed soon label May 4, 2018
@StanczakDominik StanczakDominik added help wanted Unassigned issues that would benefit from assistance or contributions needed from the community Hacktoberfest labels Sep 18, 2018
@namurphy namurphy added good first issue Good first contributions for new contributors and removed Hacktoberfest help wanted Unassigned issues that would benefit from assistance or contributions needed from the community labels Sep 18, 2018
@StanczakDominik StanczakDominik added the needs subject matter expert Requires expertise from a plasma science domain expert label Oct 16, 2018
@namurphy namurphy self-assigned this Oct 16, 2018
@StanczakDominik StanczakDominik modified the milestones: v0.2.0, v0.3.0 Apr 30, 2019
@JvPy
Copy link
Contributor

JvPy commented Dec 13, 2019

Would like to help with this issue.

Im not expert in the subject, but I can find references to the functions; also would like to make some contribution to documentation, if needed as well

@StanczakDominik StanczakDominik removed the good first issue Good first contributions for new contributors label May 10, 2020
@StanczakDominik StanczakDominik removed this from the v0.3.0 milestone Mar 11, 2021
@StanczakDominik StanczakDominik added priority: low Issues & PRs of low urgency and importance that may be deferred until later and removed priority: high Issues & PRs with significant urgency and importance that should be addressed soon labels Dec 28, 2021
@Tiger-Du
Copy link
Contributor

Tiger-Du commented Jan 1, 2022

I believe that this issue in its current scope is resolved now -- although we could expand its scope to include improving the docstrings. For example, formulas are missing for thermoelectric_conductivity, ion_viscosity, and electron_viscosity.

But perhaps it is best that we postpone improving the docstrings until we settle on a refactored version of braginskii.py as in PR #1121.

@namurphy
Copy link
Member Author

namurphy commented Jan 1, 2022

Good points! I'm thinking that a lot of the discussions of the physics will end up being copied over from the original version to the refactored version, so adding formulae to the old versions would still be helpful. With that said, I agree that it makes more sense to figure out the refactoring in #1121 first.

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 needs docstring See: https://docs.plasmapy.org/en/latest/contributing/doc_guide.html#docstrings for more info needs subject matter expert Requires expertise from a plasma science domain expert priority: low Issues & PRs of low urgency and importance that may be deferred until later transport Related to plasma transport phenomena
Projects
Development

No branches or pull requests

4 participants