docs(reference): hide internal helpers from the pkgdown reference#3
Open
truenomad wants to merge 1 commit into
Open
docs(reference): hide internal helpers from the pkgdown reference#3truenomad wants to merge 1 commit into
truenomad wants to merge 1 commit into
Conversation
The 16 per-domain indicator dictionaries (epi_dictionary, fever_dictionary, ...) and the 6 .calc_n[0-5]_internal helpers carried @Keywords internal but no @nord, so roxygen still generated Rd files and pkgdown still indexed them under 'Internal'. They are not part of the user-facing API - users get dictionaries via dhs_dictionary() and the N0-N5 cascade via calc_incidence(); the per-domain and per-N helpers exist only as implementation seams. - Add @nord alongside @Keywords internal on each. - Drop the corresponding 22 Rd files (devtools::document() regenerated). - Update the dhs-survey-analysis and methodology vignettes to point readers to dhs_dictionary() with a filter, rather than listing per-domain helpers that are no longer documented. Behaviour: these functions remain callable in-package (sntmethods::: still works); only their reference-index visibility changed.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
@noRdto the 16 per-domain indicator dictionaries (epi_dictionary,fever_dictionary,itn_dictionary, ...) and the 6.calc_n[0-5]_internalhelpers.man/*.Rdfiles (devtools::document()regenerated).dhs-survey-analysisandmethodologyvignettes to drop references to per-domain dictionary helpers, pointing readers todhs_dictionary()+ a domain filter.Why
These helpers carried
@keywords internalbut no@noRd, so roxygen still generated Rd files and pkgdown still rendered them under the auto-generated Internal section of the reference. The user-facing API isdhs_dictionary()(filterable across all 16 domains) andcalc_incidence()(which calls the.calc_n*_internalcascade); exposing the seams in the reference adds noise without helping anyone.Behaviour
Unchanged. The functions remain callable in-package — internal callers and
sntmethods:::name()still work. Only their visibility on the pkgdown site changed.Test plan
devtools::document()is a no-op on master after merge (no drift).pkgdown::build_site(): the reference index no longer lists*_dictionary(other thandhs_dictionaryandmake_dhs_raw_dictionary) nor thedot-calc_n*entries.sntmethods:::epi_dictionary()andsntmethods:::.calc_n0_internal(df, 1000)still work.