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 next_stage spec #3409

Merged
merged 3 commits into from
Jan 31, 2018
Merged

Add next_stage spec #3409

merged 3 commits into from
Jan 31, 2018

Conversation

driusan
Copy link
Collaborator

@driusan driusan commented Jan 15, 2018

Add README to next_stage module

Add README to next_stage module
@driusan driusan added Category: Documentation PR or issue that aims to improve the documentation (test plans, wiki, comments...) [branch] minor labels Jan 15, 2018

## Purpose

The `next_stage` module provides a method of start the "next stage"
Copy link
Contributor

@PapillonMcGill PapillonMcGill Jan 31, 2018

Choose a reason for hiding this comment

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

suggest "... method of starting the ..." or "... method to start the ... "

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I went with "to" since it requires less formatting change..

## Purpose

The `next_stage` module provides a method of start the "next stage"
of a candidate session. The "Stage" of an session goes from Screening
Copy link
Contributor

Choose a reason for hiding this comment

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

... of a session ...

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

done


The `next_stage` module provides a method of start the "next stage"
of a candidate session. The "Stage" of an session goes from Screening
to Visit to Approval, and the Screening and Visit stages may have
Copy link
Contributor

Choose a reason for hiding this comment

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

Approval**. The** Screening ...

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

done


## Scope

The `next_stage` module only moves from the Screening to Visit stage
Copy link
Contributor

Choose a reason for hiding this comment

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

suggest: ... only move the stage of a session from Screening to Visit.


## Permissions

Both the `data_entry` permission is required, and the user must be
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there 2 permissions required?
one suggestion is : "The data_entry permission is required. The user must also be at the same CenterID ..."

or "... The user wil only see the timepoint for CenterID where he is activated" or something similar

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, both the explicit permission with the permission code, and the same CenterID (which isn't really a permission in the code sense, but affects access) is required.

I updated it to your wording, I think it's more clear.

Copy link
Contributor

@PapillonMcGill PapillonMcGill left a comment

Choose a reason for hiding this comment

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

grammatical change required, see comments

@driusan driusan merged commit a85087f into aces:minor Jan 31, 2018
zaliqarosli pushed a commit to zaliqarosli/Loris that referenced this pull request May 2, 2018
Add README to next_stage module.
@ridz1208 ridz1208 added this to the PRE 20.0.0 milestone Sep 23, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Documentation PR or issue that aims to improve the documentation (test plans, wiki, comments...)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants