Skip to content

docs: improve commons module documentation#1055

Merged
bonjourmauko merged 9 commits intomasterfrom
documentation/commons
Oct 7, 2021
Merged

docs: improve commons module documentation#1055
bonjourmauko merged 9 commits intomasterfrom
documentation/commons

Conversation

@bonjourmauko
Copy link
Copy Markdown
Member

@bonjourmauko bonjourmauko commented Sep 29, 2021 •
edited
Loading

Fixes #1251
Follows discussion on #1033

Documentation

  • Complete the documentation of the commons module

@bonjourmauko bonjourmauko added kind:docs Add or improvement of documentation kind:theme A group of issues, directly tied to an OKR kind:roadmap A group of issues, constituting a delivery roadmap labels Sep 29, 2021
@bonjourmauko bonjourmauko requested review from a team and MattiSG September 29, 2021 13:59
@bonjourmauko bonjourmauko force-pushed the documentation/commons branch 4 times, most recently from 5006264 to c168a17 Compare October 7, 2021 09:53
@bonjourmauko bonjourmauko mentioned this pull request Oct 7, 2021
Open
18 tasks
@bonjourmauko bonjourmauko removed kind:theme A group of issues, directly tied to an OKR kind:roadmap A group of issues, constituting a delivery roadmap labels Oct 7, 2021
@bonjourmauko bonjourmauko changed the title [1/*] Improve commons module documentation [1/17] Improve commons module documentation Oct 7, 2021
MattiSG
MattiSG approved these changes Oct 7, 2021
View reviewed changes
Copy link
Copy Markdown
Member

@MattiSG MattiSG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this documentation work! 👏 I am looking forward to the systemic effects of having documentation throughout the codebase and how further contributions will improve it 😃

There is a lot of overlap with other PRs (#1033, #1060…) for task running parts, I'm looking forward to merges and rebases that will progressively allow us to focus reviews on functional / documentation changes!

openfisca_core/commons/misc.py

def __init__(self) -> None:
pass
...
Copy link
Copy Markdown
Member

@MattiSG MattiSG Oct 7, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For other reviewers wondering, this is a noop: https://stackoverflow.com/a/6189281

@bonjourmauko bonjourmauko force-pushed the documentation/commons branch from 3c68f33 to fd75c50 Compare October 7, 2021 14:13
@bonjourmauko
Copy link
Copy Markdown
Member Author

bonjourmauko commented Oct 7, 2021

Thank you for this documentation work! 👏 I am looking forward to the systemic effects of having documentation throughout the codebase and how further contributions will improve it 😃

For the "visible" end result, we still need #1054

There is a lot of overlap with other PRs (#1033, #1060…) for task running parts, I'm looking forward to merges and rebases that will progressively allow us to focus reviews on functional / documentation changes!

Yes, that was a rather painful rebase 🤣

@bonjourmauko bonjourmauko merged commit b80e54d into master Oct 7, 2021
@bonjourmauko bonjourmauko deleted the documentation/commons branch October 7, 2021 14:19
@bonjourmauko bonjourmauko mentioned this pull request Oct 22, 2021
Merged
@MattiSG MattiSG mentioned this pull request Mar 10, 2024
Closed
@bonjourmauko bonjourmauko changed the title [1/17] Improve commons module documentation docs: improve commons module documentation Sep 30, 2024
@bonjourmauko bonjourmauko mentioned this pull request Sep 30, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@MattiSG MattiSG MattiSG approved these changes

Assignees

No one assigned

Labels

kind:docs Add or improvement of documentation

Projects

OpenFisca International
Status: Inbox

Milestone

Improved doc, style & linting

Development

Successfully merging this pull request may close these issues.

Add docs to commons

2 participants

@bonjourmauko @MattiSG