More updates to documentation #446
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Callable metrics are generated which makes them constant. As Documenter.jl can include documentation for defined constants, I'm using this as a workaround to include documentation for `Metric()` type metrics.
|
Merging directly as the changes should not affect anything other than documentation. |
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR includes/adds a cookbook page and uses a workaround to include documentation for metrics which use the
Metrictype.As a bonus, the updated approach to defining metrics makes the docstring available for the built-in Julia help system.
I've noted that documentation for metrics are often incomplete or inconsistently defined. This will be addressed in a later PR.