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

Update documentation for recipes #60628

Merged
merged 1 commit into from
Sep 1, 2022
Merged

Update documentation for recipes #60628

merged 1 commit into from
Sep 1, 2022

Conversation

RenechCDDA
Copy link
Member

Summary

Infrastructure "JSON_INFO.MD documents more recipe fields"

Purpose of change

I'm looking into adding new canning recipes. The existing recipes use some fields which JSON_INFO.MD did not document.

Describe the solution

Research those fields and see how they're used in recipe.cpp. Document an example of each field and write an explanatory comment.

Describe alternatives you've considered

Testing

Additional context

@github-actions github-actions bot added <Documentation> Design documents, internal info, guides and help. [Markdown] Markdown issues and PRs Code: Infrastructure / Style / Static Analysis Code internal infrastructure and style astyled astyled PR, label is assigned by github actions json-styled JSON lint passed, label assigned by github actions BasicBuildPassed This PR builds correctly, label assigned by github actions labels Aug 31, 2022
Maleclypse
Maleclypse approved these changes Sep 1, 2022
View reviewed changes
Copy link
Member

@Maleclypse Maleclypse left a comment

Choose a reason for hiding this comment

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

Thanks for adding this documentation!

@dseguin dseguin merged commit 1bd284a into CleverRaven:master Sep 1, 2022
@RenechCDDA RenechCDDA deleted the JSON-info branch September 22, 2022 22:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Maleclypse Maleclypse Maleclypse approved these changes

Assignees
No one assigned
Labels
astyled astyled PR, label is assigned by github actions BasicBuildPassed This PR builds correctly, label assigned by github actions Code: Infrastructure / Style / Static Analysis Code internal infrastructure and style <Documentation> Design documents, internal info, guides and help. json-styled JSON lint passed, label assigned by github actions [Markdown] Markdown issues and PRs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@RenechCDDA @Maleclypse @dseguin