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.

Sign up for GitHub

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

Jump to bottom

Documentation and Unit Testing for all SOILWAT2 functions #216

Open
CaitlinA opened this issue Jul 24, 2018 · 0 comments
Open

Documentation and Unit Testing for all SOILWAT2 functions #216

CaitlinA opened this issue Jul 24, 2018 · 0 comments
Assignees
@CaitlinA @cjb643
Labels
enhancement in progress

Comments

@CaitlinA
Copy link
Member

CaitlinA commented Jul 24, 2018 •
edited
Loading

Add documentation and unit testing for all functions in SOILWAT2.

google test primer here.
Documentation info here.

Specifics about formatting and a checklist to consider before each commit can be found in the workflow_guidelines.
dschlaep added a commit that referenced this issue Oct 18, 2019
@dschlaep
Merge pull request #218 from DrylandEcology/Bugfix_117_Connor
acce170 
This version addressed documentation and unit testing:

User visible changes:
- Create and open documentation and user manual with `make doc doc_open`

Details:
- Documentation:
  - 'User manual' for SOILWAT2 provided as part of doxygen documentation (close #217, close #74)
  - Detailed installation instructions included in doxygen documentation (close #75)
  - Code contributor manual as part of doxygen documentation (close 86)
  - Doxygen warnings fixed (close #266)
  - Input units of biomass documented (close #265)

- Unit tests:
  - Contributed to the documentation and unit testing for all SOILWAT2 functions (see #216, see #219, see #76; close #73)
  - Unit tests for functions in `SW_Flow_lib.c` (close #117; contributed to #19)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@CaitlinA CaitlinA

@cjb643 cjb643

Labels
enhancement in progress
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@CaitlinA @cjb643