Skip to content

Update documentation for requisites #49962

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

Merged
merged 13 commits into from
Oct 23, 2018
Merged

Update documentation for requisites #49962

merged 13 commits into from
Oct 23, 2018

Conversation

MTecknology
Copy link
Contributor

@MTecknology MTecknology commented Oct 10, 2018

What does this PR do?

Organize and clean-up documentation.

A lot of the requisites didn't make sense to me and I struggled to understand why one would be chosen over the other because they mostly sounded the same. I tried to work through a layman explanation of what makes each requisite special.

I also attempted to consolidate repetitive explanations, remove overly-technical bits, and re-arrange things so they're easier to navigate.

Hopefully all of my changes are helpful and technically accurate, but added explanations are to the best of my comprehension, so review would be excellent.

Commits signed with GPG?

Yes

@MTecknology
Copy link
Contributor Author

@garethgreenaway Could you please make sure the description of req_any is accurate?

@MTecknology MTecknology changed the title Update documentation for requisites [WIP] Update documentation for requisites Oct 10, 2018
@MTecknology MTecknology changed the title [WIP] Update documentation for requisites Update documentation for requisites Oct 16, 2018
Copy link
Contributor

@garethgreenaway garethgreenaway left a comment

Choose a reason for hiding this comment

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

The description of require_any looks accurate.

@MTecknology
Copy link
Contributor Author

@garethgreenaway Excellent, thanks for checking!

@MTecknology
Copy link
Contributor Author

@cachedout ping? I believe I resolved all of your concerns. Do you have any others?
Also curious- if all is well, is this worth backporting to 2018.3 so current "lastest" docs can have the changes?

@rallytime rallytime requested a review from cachedout October 23, 2018 14:03
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.

3 participants