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

Add documentation on parsing life cycle and hooks #1860

Merged
merged 3 commits into from
Apr 7, 2023

Conversation

shadowspawn
Copy link
Collaborator

@shadowspawn shadowspawn commented Apr 7, 2023

Pull Request

Problem

It can be hard to work out where to plugin extra functionality using the hooks. A specific example is reading configuration files.

See: #1843

Perhaps the full life cycle of executing commands should be documented.

See also: #1762 #1787 (comment)

Solution

Add a separate description of the processing life cycles and where the hooks fit in. This will be useful when discussions come up about adding more parsing affected hooks, and thinking about where config files can fit in.

@shadowspawn shadowspawn changed the base branch from master to develop April 7, 2023 00:13
@shadowspawn shadowspawn changed the title Feature/document hooks Add documentation on parsing life cycle and hooks Apr 7, 2023
@shadowspawn shadowspawn marked this pull request as ready for review April 7, 2023 02:22
Copy link
Collaborator

@abetomo abetomo left a comment

Choose a reason for hiding this comment

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

👍

@abetomo abetomo merged commit 321cd76 into tj:develop Apr 7, 2023
@shadowspawn shadowspawn added the pending release Merged into a branch for a future release, but not released yet label Apr 7, 2023
@shadowspawn shadowspawn deleted the feature/document-hooks branch April 7, 2023 03:06
@shadowspawn shadowspawn removed the pending release Merged into a branch for a future release, but not released yet label Apr 15, 2023
@shadowspawn
Copy link
Collaborator Author

Shipped in 10.0.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants