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

Clean up parameters intro. #2585

Open
wants to merge 3 commits into
base: 8.1.x
Choose a base branch
from
Open

Clean up parameters intro. #2585

wants to merge 3 commits into from

Conversation

Rowlando13
Copy link
Contributor

Made the Parameters' first few sections cleaner and more concise.

@Rowlando13 Rowlando13 marked this pull request as draft August 12, 2023 07:58
@Rowlando13 Rowlando13 marked this pull request as ready for review August 12, 2023 23:45
tachyondecay
tachyondecay reviewed Aug 14, 2023
View reviewed changes
Copy link

@tachyondecay tachyondecay left a comment

Choose a reason for hiding this comment

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

Looks good overall—some of the lines aren’t wrapped, not sure how much this matters.

docs/parameters.rst Outdated Show resolved Hide resolved
docs/parameters.rst Outdated Show resolved Hide resolved
@Rowlando13
Copy link
Contributor Author

Fixed as @tachyondecay suggested. I generally don't split rst files at the 80 character limit since you can just use the text wrap setting. Documentation is long form writing so 80 characters does not make a lot of sense.

@davidism davidism added the docs label Sep 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tachyondecay tachyondecay tachyondecay left review comments

Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@Rowlando13 @tachyondecay @davidism