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 #10

Open
bnels opened this issue Jun 21, 2019 · 2 comments
Open

Documentation #10

bnels opened this issue Jun 21, 2019 · 2 comments
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@bnels
Copy link
Collaborator

bnels commented Jun 21, 2019

We should have some better documentation in this repository on:

  1. How to set up configuration files (and options)
  2. High level functions (and models)
  3. How to add/extend to the repository

I think (1) and (3) are known by some, but not well documented. Maybe best to do this in README.md
(2) really needs to be done (when the code is first written) in a docstring.

Minimally, the docstrings should include:

  1. A brief description of what the function does
  2. A description of the inputs
  3. A description of the outputs
  4. any assumptions the function makes (optional)
    Better yet, we should have a standardized template for this.

Yes, this should be done for the models and important functions. No, this shouldn't be required of short helper functions (but it's always nice).

@bnels bnels added enhancement New feature or request help wanted Extra attention is needed labels Jun 21, 2019
@bnels
Copy link
Collaborator Author

bnels commented Jun 25, 2019

Some progress made in #13.
README.md now has a skeleton
added contributing.md to give some guidance on docstrings.

Still more to do...

@Temigo
Copy link
Member

Temigo commented Jul 5, 2019

I will do my best to follow the Numpy conventions for docstrings:
https://numpydoc.readthedocs.io/en/latest/format.html

Temigo added a commit that referenced this issue Jul 27, 2022
Minor changes to clustering target + dictionary-based parser configurations
dkoh0207 pushed a commit to dkoh0207/lartpc_mlreco3d that referenced this issue Mar 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants