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.

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

Add docs interlinks #131

Merged
merged 5 commits into from
Dec 5, 2024
Merged

Add docs interlinks #131

merged 5 commits into from
Dec 5, 2024

Conversation

sethaxen
Copy link
Member

@sethaxen sethaxen commented Dec 2, 2024

This PR adds docs interlinks using DocumenterInterLinks, linking out to relevant Statistics/StatsBase methods and to sections of the MLJ docs.

@coveralls
Copy link

coveralls commented Dec 2, 2024

Pull Request Test Coverage Report for Build 12129334127

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 96.705%

Totals Coverage Status
Change from base Build 12109032772: 0.0%
Covered Lines: 851
Relevant Lines: 880

💛 - Coveralls

Copy link

codecov bot commented Dec 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.70%. Comparing base (9d3e4ca) to head (3635c6d).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #131   +/-   ##
=======================================
  Coverage   96.70%   96.70%           
=======================================
  Files          10       10           
  Lines         880      880           
=======================================
  Hits          851      851           
  Misses         29       29           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sethaxen
Copy link
Member Author

sethaxen commented Dec 3, 2024

The main downside I see to this approach is that links in the REPL are somewhat less pretty/informative. e.g.

julia> """
           my_mean(x)
           
       My version of [`Statistics.mean`](@extref). See [Statistics docs](@extref Statistics `Statistics`).

       See also: [`my_std`](@ref).
       """
       function my_mean end
my_mean

help?> my_mean
search: my_mean

  my_mean(x)

  My version of Statistics.mean (@extref). See Statistics docs (@extref Statistics `Statistics`).

  See also: my_std.

Still, I think this is better than the alternative of not linking out to other docs.

@sethaxen sethaxen marked this pull request as ready for review December 3, 2024 22:04
@sethaxen sethaxen requested a review from devmotion December 3, 2024 22:04
docs/make.jl Show resolved Hide resolved
@sethaxen sethaxen merged commit 438da79 into main Dec 5, 2024
13 checks passed
@sethaxen sethaxen deleted the docsinterlinks branch December 5, 2024 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants