Refresh the documentation landing page and the roadmap - #332
Merged
Merged
Conversation
The landing page said function documentation would arrive 'in the future', which #324 has since added, so the first page of the docs told a reader the API reference does not exist. It now describes what the package does, installs it, and links to both pages. examples.md opened with 'See these rendered Jupyter notebooks' followed by no links. It now links the one notebook there is. The roadmap claimed graphs and Tax-Calculator helpers, neither of which is in the package - grep finds no taxcalc reference and no plotting code - and listed replicate-weight standard errors as future work, which shipped in #320 and is the paper's headline feature. Replaced with what the package does and three things it does not do yet.
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
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.
Three stale documents a JOSS reviewer reads early, found in a pre-submission review.
docs/home.md— the landing page said the API reference does not existIn full, before this PR:
#324 added
docs/api.md. So the first page of the documentation told a reader the function documentation was still to come. A reviewer scoring the "functional documentation" checkbox reads this page first.It now says what the package does, gives the
pip install microdf-pythonline, shows a three-line example (which I ran — median 30000, gini 0.2829), and links to both the examples and the API reference.docs/examples.md— a dangling referenceOpened with "See these rendered Jupyter notebooks for examples of
microdfusage" followed by no links to any notebook. Now links the one notebook that exists. The weight-preservation section below it is untouched.ROADMAP.md— stale in both directionsgrep -ril taxcalc microdf/returns nothing, and there is no plotting code in the package.Replaced with what the package actually provides and three things it genuinely does not do yet — design-based variance from stratum and cluster identifiers, dataset presets, and wider pandas shape-change coverage.
No package code changes.