Start adding docs to prior estimation.#17
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation to the base prior estimation module by adding detailed docstrings to all abstract types and functions in the prior estimation hierarchy. The documentation follows Julia's standard format with code snippets, descriptions, and cross-references.
Key changes:
- Added comprehensive docstrings to all abstract types in the prior estimation hierarchy
- Added documentation for core functions like
prior,clusterise,centrality_vector, etc. - Updated the documentation index to include all documented types and functions
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/13_Prior/1_Base_Prior.jl | Added detailed docstrings to all abstract types and functions in the prior estimation module |
| docs/src/api/13_Prior/1_BasePrior.md | Updated documentation index to include all newly documented types and functions |
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #17 +/- ##
==========================================
- Coverage 84.54% 84.49% -0.05%
==========================================
Files 111 111
Lines 11918 11925 +7
==========================================
Hits 10076 10076
- Misses 1842 1849 +7 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| elseif i == 3 | ||
| 5e-4 | ||
| elseif i == 4 || Sys.isapple() && i == 12 | ||
| elseif i in (4, 12) |
There was a problem hiding this comment.
[nitpick] Consider using a more descriptive approach for these magic numbers. Define constants or add comments explaining why indices 4 and 12 require special tolerance handling.
1 participant
No description provided.