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.

Sign up for GitHub

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

Jump to bottom

Fix documentation #1038

Merged
merged 40 commits into from
Sep 9, 2021
Merged

Fix documentation #1038

merged 40 commits into from
Sep 9, 2021

Conversation

bonjourmauko
Copy link
Member

@bonjourmauko bonjourmauko commented Aug 26, 2021 •
edited
Loading

Partially fixes openfisca/openfisca-doc#244
Depended upon by #1033 #1021

New Features

  • Introduce openfisca_core.variables.typing
    • Documents the signature of formulas
    • Note: as formulas are generated dynamically, documenting them is tricky

Bug Fixes

  • Fix the official doc
    • Corrects malformed docstrings
    • Fix missing and/ou outdated references

Technical Changes

  • Add tasks to automatically validate that changes do not break the documentation

Documentation

  • Add steps to follow in case the documentation is broken
  • Add general documenting guidelines in CONTRIBUTING.md

Capture d’écran 2021-08-26 à 16 57 13

@bonjourmauko bonjourmauko added the kind:fix Bugs are defects and failure demand. label Aug 26, 2021
@bonjourmauko bonjourmauko requested a review from a team August 26, 2021 15:03
@bonjourmauko bonjourmauko mentioned this pull request Aug 26, 2021
Merged
@bonjourmauko bonjourmauko mentioned this pull request Aug 29, 2021
Merged
@bonjourmauko bonjourmauko mentioned this pull request Aug 30, 2021
Closed
@bonjourmauko bonjourmauko mentioned this pull request Sep 7, 2021
Draft
@benjello
Copy link
Member

benjello commented Sep 9, 2021

Thanks @maukoquiroga ! I tested make test-doc and it worked well.
I didn't test the occurrence of an error and how to fix it, but I am all in afvor of merging this PR and improving it if needed later when use case emerge.

@benjello
Copy link
Member

benjello commented Sep 9, 2021

@HAEKADI, I assume that you are almost aligned with me ;-) (or do not have a strong opinion which is equivalent)
Review from @MattiSG and @sandcha might be useful as well ! ()

@bonjourmauko bonjourmauko merged commit 4c48564 into master Sep 9, 2021
@bonjourmauko bonjourmauko deleted the fix-doc branch September 9, 2021 10:36
@bonjourmauko bonjourmauko changed the title Fix documentation [2/10] Fix documentation Sep 15, 2021
@bonjourmauko bonjourmauko changed the title [2/10] Fix documentation [1/10] Fix documentation Sep 29, 2021
@bonjourmauko bonjourmauko added this to the Doc/tests milestone Sep 29, 2021
@bonjourmauko bonjourmauko added the kind:theme A group of issues, directly tied to an OKR label Sep 29, 2021
@bonjourmauko bonjourmauko modified the milestones: Doc/tests, Improve testing & releases Sep 29, 2021
@bonjourmauko bonjourmauko changed the title [1/10] Fix documentation Fix documentation Sep 29, 2021
@bonjourmauko bonjourmauko added kind:roadmap A group of issues, constituting a delivery roadmap and removed kind:theme A group of issues, directly tied to an OKR labels Sep 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benjello benjello benjello approved these changes

@HAEKADI HAEKADI Awaiting requested review from HAEKADI

Assignees
No one assigned
Labels
kind:fix Bugs are defects and failure demand. kind:roadmap A group of issues, constituting a delivery roadmap
Projects
None yet
Milestone
Improved doc, style & linting
Development

Successfully merging this pull request may close these issues.

Python API documentation seems broken
3 participants
@bonjourmauko @benjello @HAEKADI