Skip to content

Conversation

@waldyrious
Copy link
Member

@waldyrious waldyrious commented Jul 10, 2025

This PR includes several changes to the docs

  • Fix a couple typos in the docs (including one that broke a reference link)
  • Remove backticks from @ref links to macros (so the links will actually work instead of point to a 404 page)
  • Normalize whitespace in docs (two spaces between sentences; soft wrapping in .md files; semantic wrapping in .jl files)
  • Add a full reference documentation page (via the autodocs macro)
  • Add docs/build/ to the .gitignore file

Each change above corresponds to a separate commit, so they can be reviewed independently, and if any of them are not desirable, they can be easily removed from the branch.

(This PR is a follow-up to #26.)

@codecov-commenter
Copy link

codecov-commenter commented Jul 10, 2025

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (master@fa40e78). Learn more about missing BASE report.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff            @@
##             master      #29   +/-   ##
=========================================
  Coverage          ?   96.42%           
=========================================
  Files             ?        1           
  Lines             ?       56           
  Branches          ?        0           
=========================================
  Hits              ?       54           
  Misses            ?        2           
  Partials          ?        0           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@waldyrious
Copy link
Member Author

waldyrious commented Jul 11, 2025

A couple questions from the docs build log:

  1. Can we fix the two warnings about duplicate docs found for Gettext.bindtextdomain and Gettext.textdomain? I wonder why they were defined as docstrings attached to loose tokens separate from the actual functions. Is that a Documenter.jl idiom?

  2. Could we activate previews for docs changes such as this? The build log reports that the push_preview keyword argument to deploydocs was not set to true. Is it just a matter of turning that on, or would we need additional configuration?

@waldyrious waldyrious requested a review from stevengj July 15, 2025 21:52
@stevengj
Copy link
Member

stevengj commented Jul 16, 2025

Mostly LGTM. I'm not sure if the @autodocs section is needed, though, however since we already have @docs blocks for all of the docstrings?

(And if the same docstring is included in a manual @docs block and an @autodocs block, which one will a @ref link point to?)

I defined the docstrings for textdomain and bindtextdomain as "loose" docstrings because each function had two methods and it wasn't clear which method to attach the docstring too. That's a part of Julia's docstring syntax, not specific to Documenter.jl

Why are we getting a warning?

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