Update Documentation With Examples
Open
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 0
- Forks
- 0
- Avg merge
- 10h 7m
- Merged PRs (30d)
- 4
Description
Ryan,
There needs to be example code to call the NuclearRepulsion class. Also there should be instructions on how to compile.
Eric
Originally posted by @ebylaska in https://github.com/NWChemEx-Project/PropertyTypes/pull/2#issuecomment-497854051
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No specific documentation file or test is named. Locate the NuclearRepulsion class and the existing compilation instructions, then add a usage example and clear build guidance; done means a newcomer can see how to call the class and compile the project.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100