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

Documentation for core/energy_pdf.py #40

Open
JannisNe opened this issue May 6, 2021 · 2 comments
Open

Documentation for core/energy_pdf.py #40

JannisNe opened this issue May 6, 2021 · 2 comments

Comments

@JannisNe
Copy link
Collaborator

JannisNe commented May 6, 2021

Is your feature request related to a problem? Please describe.
I'm always frustrated when there is no documentation for code.

Describe the solution you'd like
I want documented code. More so probably people from outside using Flarestack.

Describe alternatives you've considered
Not adding documentation. Makes it harder for everyone though.

Additional context
This is necessary if a JOSS paper is the goal.

@JannisNe JannisNe added this to the Documentation milestone May 6, 2021
@JannisNe JannisNe self-assigned this May 6, 2021
@JannisNe JannisNe added this to To do in JOSS Paper requirements via automation May 6, 2021
@JannisNe
Copy link
Collaborator Author

JannisNe commented May 6, 2021

@robertdstein Is the EnergyPDFConstructor still being used or an inactive relic?

@robertdstein
Copy link
Member

So I just checked, and I believe it is a relic. If the code is not being used/imported anywhere it is probably redundant. The commented code below is also a (python2) relic that can be removed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

2 participants