-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Fix $args
automatic variable case
#11824
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
Fix $args
automatic variable case
#11824
Conversation
ExpectationsThanks for your submission! Here's a quick note to provide you with some context for what to expect from the docs team and the process now that you've submitted a PR. Even if you've contributed to this repo before, we strongly suggest reading this information; it might have changed since you last read it. To see our process for reviewing PRs, please read our editor's checklist and process for managing pull requests in particular. Below is a brief, high-level summary of what to expect, but our contributor guide has expanded details. The docs team begins to review your PR if you request them to or if your PR meets these conditions:
You can always request a review at any stage in your authoring process, the docs team is here to help! You do not need to submit a fully polished and finished draft; the docs team can help you get content ready for merge. While reviewing your PR, the docs team may make suggestions, write comments, and ask questions. When all requirements are satisfied, the docs team marks your PR as Approved and merges it. Once your PR is merged, it is included the next time the documentation is published. For this project, the documentation is published daily at 3 p.m. Pacific Standard Time (PST). |
@sdwheeler I have 25 commits in total, one for each automatic variable that requires a fix. The number of files touched per commit ranges from 1-153. I don't want to overwhelm a single PR review, nor generate a large number of conflicts due to the number of touched files. If I submit one PR, wait for it to be reviewed/merged and then submit another based on updated E.g., the |
@surfingoldelephant Limit the PRs to 30-40 files. It's best to include the same files for all versions in a single PR, like you did in this PR. |
Just to clarify, it was simpler/less error-prone to fix one variable at a time, committing after each fixed variable. So the changes are on a per-variable basis, not file. E.g.,
There are three variables that exceed the 40 file limit: |
Oh, I understand now. In my mind, the changes are small and related. I would rather get a PR that contains changes for all variables, but limit the file count and include all affected versions. For example, fix all the variables in 10 files across 4 versions in 1 PR. |
I initially considered this, but felt this approach would've made the fix considerably more complex.
Understood. I'll be sure to keep this in mind in the future. For now, I can't see a clean way of transforming what I have into PRs that satisfy this. I've fixed all variables across all files - just not in the manner you're looking for PR-wise. I'll submit one more PR with what I have and let you decide how you want to proceed. |
$args
automatic variable case (1/13)$args
automatic variable case
PR Summary
This PR fixes incorrect automatic variable casing used throughout the documentation. E.g.,
$Args
(incorrect) ->$args
(correct).In this PR:
$args
Context
This series of PRs ensures the correct case is consistently used for each individual automatic variable, as documented in
about_Automatic_Variables
and verified by tab completion.Changes in scope:
$
or@
sigil.Out of scope:
$Input
).false
/False
/FALSE
when referring to the value of$false
).PR Checklist