Docs update with DocStringExtensions #98
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose and Content
Adds DocStringExtensions.jl to the src directory. Primarily uses
DocStringExtensions.@template
to create uniform docstrings. Also updates the API docs.Benefits and Risks
DocStringExtensions will make our docs more robust to code changes (signature updates, field updates, etc). Using
@template
also ensures that the same information is included in docstrings for the same types of info (methods, types, etc) and streamlines what we need to write.Linked Issues
Closes #64
Part of #84
PR Checklist