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

Update documentation to include on_response blocks (with feedback addressed) #2616

Conversation

Projects
None yet
1 participant
@floehopper
Copy link
Contributor

commented Jul 6, 2016

Description

Supersedes #2608.

Trello card: https://trello.com/c/kWO8Z3i1

In #2408 we introduced on_response blocks with the idea of using them to build and store a calculator object in a calculator state variable, and to manually store the response to each question on the calculator. This is instead of using save_input_as which stores the response as a state variable. This is because in moving towards new-style flows, we're trying to move away from storing any "state variables" other than a single calculator object.

Note that this PR is not an attempt to address the action in this Trello card from the benefit-cap-calculator retrospective. I plan to address that action separately. The idea of this PR is simply to bring the existing documentation up-to-date with the existence of the on_response method.

External changes

None. This only changes documentation.

floehopper added some commits Jun 30, 2016

Minor fixes for flow-definition documentation
This file was split out of `doc/smart-answer-flows.md` in #2169. However, the
references to other sections of that file were not updated. These sections were
also split out into their own files in the same pull request.

This commit updates the references to link to the other files.
Update refactoring docs to reflect use of on_response blocks
In #2408 we introduced `on_response` blocks with the idea of using them to build
and store a calculator object in a `calculator` state variable, and to manually
store the response to each question on the calculator. This is instead of using
`save_input_as` which stores the response as a state variable.
Add caveat to docs to discourage addition of new calculate blocks
While this paragraph still offers useful advice, I don't want it to encourage
people to add *new* `calculate` blocks.
Update storing-data docs to reflect use of on_response blocks
In #2408 we introduced `on_response` blocks with the idea of using them to build
and store a calculator object in a `calculator` state variable, and to manually
store the response to each question on the calculator. This is instead of using
`save_input_as` which stores the response as a state variable.

This commit updates the documentation to reflect the new state of affairs.
Update storing-data example to reflect use of on_response blocks
In #2408 we introduced `on_response` blocks with the idea of using them to build
and store a calculator object in a `calculator` state variable, and to manually
store the response to each question on the calculator. This is instead of using
`save_input_as` which stores the response as a state variable.

This commit updates the documentation to reflect the new state of affairs.

@floehopper floehopper merged commit 0c76b22 into master Jul 6, 2016

1 check passed

default "Build #5560 succeeded on Jenkins"
Details

@floehopper floehopper deleted the update-documentation-to-include-on-response-blocks-with-feedback-addressed branch Jul 6, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.