-
Notifications
You must be signed in to change notification settings - Fork 89
Re-structure the docs into sections #325
Re-structure the docs into sections #325
Conversation
🤖 zincr found 0 problems , 1 warning
Details on how to resolve are provided below Large CommitsChecks all commits for large additions to a single file. Large commits should be reviewed more carefully for potential copyright and licensing issues This file contains a substantial change, please review to determine if the change comes from an external source and if there are any copyright or licensing issues to be aware of
|
🤖 zincr found 1 problem , 1 warning
Details on how to resolve are provided below ApprovalsAll proposed changes must be reviewed by project maintainers before they can be merged Not enough people have approved this pull request - please ensure that 1 additional user, who have not contributed to this pull request approve the changes.
Large CommitsChecks all commits for large additions to a single file. Large commits should be reviewed more carefully for potential copyright and licensing issues This file contains a substantial change, please review to determine if the change comes from an external source and if there are any copyright or licensing issues to be aware of
|
What do these changes do?
Re-structures the documentation into multiple sections, and extracts some common topics from the Handlers page to their own (kwargs, error handling, filtering, etc).
Description
As new types of handlers and decorators are being added (e.g. activities), the docs were growing and eventually ended up being overloaded with informations. As even more handlers are going to appear soon (e.g. daemons & timers), it requires re-structuring the docs, specifically extracting some common topics as separate pages.
Some new docs are also written: slightly more verbose on kwargs, totally new for results delivery.
A preview is temporarily available at:
Issues/PRs
Type of changes
Checklist
CONTRIBUTORS.txt