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.

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

Refactor documentation #623

Merged
merged 1 commit into from Jul 15, 2020
Merged

Conversation

yakky
Copy link
Member

@yakky yakky commented Jul 5, 2020

Description

Refactor documentation to improve:

  • maintainability by keeping documentation and code in the same place
  • clarity by rewording
  • depth by exposing api autodoc

Temporarely targeted to #621 for easier review, to be rebased after #621 is merged

References

Fix #622

Checklist

  • I have read the contribution guide
  • Code lint checked via inv lint
  • changes file included (see docs)
  • Usage documentation added in case of new features
  • Tests added

@yakky yakky added this to the 1.2 milestone Jul 5, 2020
@codecov
Copy link

codecov bot commented Jul 5, 2020

Codecov Report

Merging #623 into develop will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #623   +/-   ##
========================================
  Coverage    94.14%   94.14%           
========================================
  Files           22       22           
  Lines         1041     1041           
  Branches       137      137           
========================================
  Hits           980      980           
  Misses          23       23           
  Partials        38       38           
Flag Coverage Δ
#unittests 94.14% <0.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1cfb8d9...63f47e6. Read the comment docs.

@coveralls
Copy link

coveralls commented Jul 5, 2020

Coverage Status

Coverage increased (+0.1%) to 96.74% when pulling 15a82a1 on feature/issue-622-improve-documentation into 7e9536b on feature/issue-620-admin-customization.

@yakky yakky force-pushed the feature/issue-622-improve-documentation branch 2 times, most recently from 09b0468 to 15a82a1 Compare July 5, 2020 22:43
@yakky yakky requested a review from protoroto July 13, 2020 14:45
@yakky yakky marked this pull request as ready for review July 13, 2020 14:45
Copy link
Member

@protoroto protoroto left a comment

Choose a reason for hiding this comment

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

LGTM

@yakky yakky changed the base branch from feature/issue-620-admin-customization to develop July 15, 2020 21:41
@yakky yakky changed the base branch from develop to feature/issue-620-admin-customization July 15, 2020 21:41
@yakky yakky force-pushed the feature/issue-622-improve-documentation branch from 15a82a1 to 63f47e6 Compare July 15, 2020 21:42
@yakky yakky changed the base branch from feature/issue-620-admin-customization to develop July 15, 2020 21:46
@yakky yakky merged commit 261c342 into develop Jul 15, 2020
@yakky yakky mentioned this pull request Apr 20, 2023
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve setting documentation
3 participants