Adjust consents docs to support a less technical audience #2463
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pbanaszkiewicz
approved these changes
Jul 12, 2023
docs/amy_database_structure.md
Outdated
| `consents_termoption` - Stores all options for a stored `Term` in AMY. `TermOptions` are displayed when the user is asked to consent to a `Term`, | ||
| and are considered answer choices for the `Term`. | ||
| `consents_termoption` - Stores all options for all terms in AMY. Options are displayed when the user is asked to consent to a particular term, | ||
| and are considered answer choices for are term. |
There was a problem hiding this comment.
I think there's a typo somewhere in this line. I'm guessing that the whole sentence could and in L242 ("Options are displayed when the user is asked to consent to a particular term."), and L243 could be a new sentence: "TermOptions are answer choices for the term". What do you think?
Co-authored-by: Piotr Banaszkiewicz <piotr@banaszkiewicz.org>
|
All good suggestions, thanks @pbanaszkiewicz! I'll wait for @maneesha to also take a look before merging |
|
looks good to me! |
|
@elichad Have I moved this by accident to Email Automation project, or was it someone else? |
|
@pbanaszkiewicz it looks like an accident to me. I'll take it out of that project |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In line with #2422, makes the "Database Structure" docs for consents a bit less technical.