-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Replace some 2 letter variables for readability #1845
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
Conversation
This file contains hidden or 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
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Ignored Deployment
|
9b8be11
to
797cfb6
Compare
797cfb6
to
94f09ed
Compare
While working on another task, I found several things hard to read because of short variable names. Although types and "Go to Definition" helps in these cases, long function blocks and large files make it dfficult to focus on the task at hand. For example, in some cases, the variable `ht` and `th` appear side by side in the same block! This commit replaces some of these names to improve general readability (and also to reduce the diff in future behavior-changing work).
94f09ed
to
9d2bee5
Compare
nathanhammond
approved these changes
Sep 5, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is fine; I do want to mention that the receiver
in methods for Go is generally left as 1-2 characters. (None of those were renamed. 👍)
fuxingloh
referenced
this pull request
in fuxingloh/contented
Sep 9, 2022
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [turbo](https://turborepo.org) ([source](https://togithub.com/vercel/turborepo)) | [`^1.4.3` -> `^1.4.6`](https://renovatebot.com/diffs/npm/turbo/1.4.3/1.4.6) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>vercel/turborepo</summary> ### [`v1.4.6`](https://togithub.com/vercel/turborepo/releases/tag/v1.4.6) [Compare Source](https://togithub.com/vercel/turborepo/compare/v1.4.5...v1.4.6) #### What's Changed ##### Internal - fix(deps): update dependency ora to v4.1.1 by [@​renovate](https://togithub.com/renovate) in [https://github.com/vercel/turborepo/pull/1854](https://togithub.com/vercel/turborepo/pull/1854) - Don't special case version command by [@​gsoltis](https://togithub.com/gsoltis) in [https://github.com/vercel/turborepo/pull/1870](https://togithub.com/vercel/turborepo/pull/1870) - fix(deps): update dependency react-hot-toast to v2.3.0 by [@​renovate](https://togithub.com/renovate) in [https://github.com/vercel/turborepo/pull/1875](https://togithub.com/vercel/turborepo/pull/1875) - chore(deps): update jamesives/github-pages-deploy-action action to v4.4.0 by [@​renovate](https://togithub.com/renovate) in [https://github.com/vercel/turborepo/pull/1851](https://togithub.com/vercel/turborepo/pull/1851) - chore(deps): update dependency typescript to v4.8.2 by [@​renovate](https://togithub.com/renovate) in [https://github.com/vercel/turborepo/pull/1849](https://togithub.com/vercel/turborepo/pull/1849) - chore(deps): update dependency esbuild to ^0.15.0 by [@​renovate](https://togithub.com/renovate) in [https://github.com/vercel/turborepo/pull/1848](https://togithub.com/vercel/turborepo/pull/1848) - Enable pnpm@6 testing. by [@​7flash](https://togithub.com/7flash) in [https://github.com/vercel/turborepo/pull/1837](https://togithub.com/vercel/turborepo/pull/1837) - fix(deps): update dependency eslint-plugin-react to v7.31.7 by [@​renovate](https://togithub.com/renovate) in [https://github.com/vercel/turborepo/pull/1834](https://togithub.com/vercel/turborepo/pull/1834) - chore(deps): update dependency [@​types/react](https://togithub.com/types/react) to v17.0.49 by [@​renovate](https://togithub.com/renovate) in [https://github.com/vercel/turborepo/pull/1833](https://togithub.com/vercel/turborepo/pull/1833) - Replace some 2 letter variables for readability by [@​mehulkar](https://togithub.com/mehulkar) in [https://github.com/vercel/turborepo/pull/1845](https://togithub.com/vercel/turborepo/pull/1845) ##### Documentation - Remove unused packages from docs site by [@​mehulkar](https://togithub.com/mehulkar) in [https://github.com/vercel/turborepo/pull/1828](https://togithub.com/vercel/turborepo/pull/1828) - Consolidated 'workspace' and 'package' terminology by [@​mattpocock](https://togithub.com/mattpocock) in [https://github.com/vercel/turborepo/pull/1817](https://togithub.com/vercel/turborepo/pull/1817) - Rewrote docs homepage by [@​mattpocock](https://togithub.com/mattpocock) in [https://github.com/vercel/turborepo/pull/1756](https://togithub.com/vercel/turborepo/pull/1756) - Update existing-monorepo.mdx by [@​shemayas](https://togithub.com/shemayas) in [https://github.com/vercel/turborepo/pull/1858](https://togithub.com/vercel/turborepo/pull/1858) - Update Docs by [@​PhentomPT](https://togithub.com/PhentomPT) in [https://github.com/vercel/turborepo/pull/1794](https://togithub.com/vercel/turborepo/pull/1794) - Fix broken links on "Add to existing Monorepo" by [@​pakaponk](https://togithub.com/pakaponk) in [https://github.com/vercel/turborepo/pull/1836](https://togithub.com/vercel/turborepo/pull/1836) ##### Examples - Removed parallel flag from basic example by [@​mattpocock](https://togithub.com/mattpocock) in [https://github.com/vercel/turborepo/pull/1787](https://togithub.com/vercel/turborepo/pull/1787) - Renamed storybook components by [@​samuelhorn](https://togithub.com/samuelhorn) in [https://github.com/vercel/turborepo/pull/1841](https://togithub.com/vercel/turborepo/pull/1841) ##### Packages - fix(eslint): exclude variables in rule by [@​tknickman](https://togithub.com/tknickman) in [https://github.com/vercel/turborepo/pull/1865](https://togithub.com/vercel/turborepo/pull/1865) #### New Contributors - [@​shemayas](https://togithub.com/shemayas) made their first contribution in [https://github.com/vercel/turborepo/pull/1858](https://togithub.com/vercel/turborepo/pull/1858) - [@​7flash](https://togithub.com/7flash) made their first contribution in [https://github.com/vercel/turborepo/pull/1837](https://togithub.com/vercel/turborepo/pull/1837) - [@​PhentomPT](https://togithub.com/PhentomPT) made their first contribution in [https://github.com/vercel/turborepo/pull/1794](https://togithub.com/vercel/turborepo/pull/1794) **Full Changelog**: vercel/turborepo@v1.4.5...v1.4.6 ### [`v1.4.5`](https://togithub.com/vercel/turborepo/releases/tag/v1.4.5) [Compare Source](https://togithub.com/vercel/turborepo/compare/v1.4.4...v1.4.5) #### What's Changed ##### Core - Split notion of logged in into user and linked-team by [@​gsoltis](https://togithub.com/gsoltis) in [https://github.com/vercel/turborepo/pull/1844](https://togithub.com/vercel/turborepo/pull/1844) ##### Documentation - Turborepo usage. by [@​nathanhammond](https://togithub.com/nathanhammond) in [https://github.com/vercel/turborepo/pull/1827](https://togithub.com/vercel/turborepo/pull/1827) - Remove unused [@​react-aria/radio](https://togithub.com/react-aria/radio) package by [@​mehulkar](https://togithub.com/mehulkar) in [https://github.com/vercel/turborepo/pull/1826](https://togithub.com/vercel/turborepo/pull/1826) - Fix broken links at "Next Steps" on "Add to Existing Monorepo" by [@​pakaponk](https://togithub.com/pakaponk) in [https://github.com/vercel/turborepo/pull/1835](https://togithub.com/vercel/turborepo/pull/1835) - Upgrade Nextra by [@​shuding](https://togithub.com/shuding) in [https://github.com/vercel/turborepo/pull/1831](https://togithub.com/vercel/turborepo/pull/1831) **Full Changelog**: vercel/turborepo@v1.4.4...v1.4.5 ### [`v1.4.4`](https://togithub.com/vercel/turborepo/compare/v1.4.3...v1.4.4) [Compare Source](https://togithub.com/vercel/turborepo/compare/v1.4.3...v1.4.4) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/BirthdayResearch/contented). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzMi4xODYuMiIsInVwZGF0ZWRJblZlciI6IjMyLjE5NC4yIn0=--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
fuxingloh
referenced
this pull request
in DeFiCh/metachain
Sep 12, 2022
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [turbo](https://turborepo.org) ([source](https://togithub.com/vercel/turborepo)) | [`^1.4.5` -> `^1.4.6`](https://renovatebot.com/diffs/npm/turbo/1.4.5/1.4.6) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>vercel/turborepo</summary> ### [`v1.4.6`](https://togithub.com/vercel/turborepo/releases/tag/v1.4.6) [Compare Source](https://togithub.com/vercel/turborepo/compare/v1.4.5...v1.4.6) #### What's Changed ##### Internal - fix(deps): update dependency ora to v4.1.1 by [@​renovate](https://togithub.com/renovate) in [https://github.com/vercel/turborepo/pull/1854](https://togithub.com/vercel/turborepo/pull/1854) - Don't special case version command by [@​gsoltis](https://togithub.com/gsoltis) in [https://github.com/vercel/turborepo/pull/1870](https://togithub.com/vercel/turborepo/pull/1870) - fix(deps): update dependency react-hot-toast to v2.3.0 by [@​renovate](https://togithub.com/renovate) in [https://github.com/vercel/turborepo/pull/1875](https://togithub.com/vercel/turborepo/pull/1875) - chore(deps): update jamesives/github-pages-deploy-action action to v4.4.0 by [@​renovate](https://togithub.com/renovate) in [https://github.com/vercel/turborepo/pull/1851](https://togithub.com/vercel/turborepo/pull/1851) - chore(deps): update dependency typescript to v4.8.2 by [@​renovate](https://togithub.com/renovate) in [https://github.com/vercel/turborepo/pull/1849](https://togithub.com/vercel/turborepo/pull/1849) - chore(deps): update dependency esbuild to ^0.15.0 by [@​renovate](https://togithub.com/renovate) in [https://github.com/vercel/turborepo/pull/1848](https://togithub.com/vercel/turborepo/pull/1848) - Enable pnpm@6 testing. by [@​7flash](https://togithub.com/7flash) in [https://github.com/vercel/turborepo/pull/1837](https://togithub.com/vercel/turborepo/pull/1837) - fix(deps): update dependency eslint-plugin-react to v7.31.7 by [@​renovate](https://togithub.com/renovate) in [https://github.com/vercel/turborepo/pull/1834](https://togithub.com/vercel/turborepo/pull/1834) - chore(deps): update dependency [@​types/react](https://togithub.com/types/react) to v17.0.49 by [@​renovate](https://togithub.com/renovate) in [https://github.com/vercel/turborepo/pull/1833](https://togithub.com/vercel/turborepo/pull/1833) - Replace some 2 letter variables for readability by [@​mehulkar](https://togithub.com/mehulkar) in [https://github.com/vercel/turborepo/pull/1845](https://togithub.com/vercel/turborepo/pull/1845) ##### Documentation - Remove unused packages from docs site by [@​mehulkar](https://togithub.com/mehulkar) in [https://github.com/vercel/turborepo/pull/1828](https://togithub.com/vercel/turborepo/pull/1828) - Consolidated 'workspace' and 'package' terminology by [@​mattpocock](https://togithub.com/mattpocock) in [https://github.com/vercel/turborepo/pull/1817](https://togithub.com/vercel/turborepo/pull/1817) - Rewrote docs homepage by [@​mattpocock](https://togithub.com/mattpocock) in [https://github.com/vercel/turborepo/pull/1756](https://togithub.com/vercel/turborepo/pull/1756) - Update existing-monorepo.mdx by [@​shemayas](https://togithub.com/shemayas) in [https://github.com/vercel/turborepo/pull/1858](https://togithub.com/vercel/turborepo/pull/1858) - Update Docs by [@​PhentomPT](https://togithub.com/PhentomPT) in [https://github.com/vercel/turborepo/pull/1794](https://togithub.com/vercel/turborepo/pull/1794) - Fix broken links on "Add to existing Monorepo" by [@​pakaponk](https://togithub.com/pakaponk) in [https://github.com/vercel/turborepo/pull/1836](https://togithub.com/vercel/turborepo/pull/1836) ##### Examples - Removed parallel flag from basic example by [@​mattpocock](https://togithub.com/mattpocock) in [https://github.com/vercel/turborepo/pull/1787](https://togithub.com/vercel/turborepo/pull/1787) - Renamed storybook components by [@​samuelhorn](https://togithub.com/samuelhorn) in [https://github.com/vercel/turborepo/pull/1841](https://togithub.com/vercel/turborepo/pull/1841) ##### Packages - fix(eslint): exclude variables in rule by [@​tknickman](https://togithub.com/tknickman) in [https://github.com/vercel/turborepo/pull/1865](https://togithub.com/vercel/turborepo/pull/1865) #### New Contributors - [@​shemayas](https://togithub.com/shemayas) made their first contribution in [https://github.com/vercel/turborepo/pull/1858](https://togithub.com/vercel/turborepo/pull/1858) - [@​7flash](https://togithub.com/7flash) made their first contribution in [https://github.com/vercel/turborepo/pull/1837](https://togithub.com/vercel/turborepo/pull/1837) - [@​PhentomPT](https://togithub.com/PhentomPT) made their first contribution in [https://github.com/vercel/turborepo/pull/1794](https://togithub.com/vercel/turborepo/pull/1794) **Full Changelog**: vercel/turborepo@v1.4.5...v1.4.6 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/DeFiCh/metachain). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzMi4xOTQuMyIsInVwZGF0ZWRJblZlciI6IjMyLjE5NC4zIn0=--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
canonbrother
referenced
this pull request
in DeFiCh/metachain
Sep 28, 2022
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [turbo](https://turborepo.org) ([source](https://togithub.com/vercel/turborepo)) | [`^1.4.5` -> `^1.4.6`](https://renovatebot.com/diffs/npm/turbo/1.4.5/1.4.6) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>vercel/turborepo</summary> ### [`v1.4.6`](https://togithub.com/vercel/turborepo/releases/tag/v1.4.6) [Compare Source](https://togithub.com/vercel/turborepo/compare/v1.4.5...v1.4.6) #### What's Changed ##### Internal - fix(deps): update dependency ora to v4.1.1 by [@​renovate](https://togithub.com/renovate) in [https://github.com/vercel/turborepo/pull/1854](https://togithub.com/vercel/turborepo/pull/1854) - Don't special case version command by [@​gsoltis](https://togithub.com/gsoltis) in [https://github.com/vercel/turborepo/pull/1870](https://togithub.com/vercel/turborepo/pull/1870) - fix(deps): update dependency react-hot-toast to v2.3.0 by [@​renovate](https://togithub.com/renovate) in [https://github.com/vercel/turborepo/pull/1875](https://togithub.com/vercel/turborepo/pull/1875) - chore(deps): update jamesives/github-pages-deploy-action action to v4.4.0 by [@​renovate](https://togithub.com/renovate) in [https://github.com/vercel/turborepo/pull/1851](https://togithub.com/vercel/turborepo/pull/1851) - chore(deps): update dependency typescript to v4.8.2 by [@​renovate](https://togithub.com/renovate) in [https://github.com/vercel/turborepo/pull/1849](https://togithub.com/vercel/turborepo/pull/1849) - chore(deps): update dependency esbuild to ^0.15.0 by [@​renovate](https://togithub.com/renovate) in [https://github.com/vercel/turborepo/pull/1848](https://togithub.com/vercel/turborepo/pull/1848) - Enable pnpm@6 testing. by [@​7flash](https://togithub.com/7flash) in [https://github.com/vercel/turborepo/pull/1837](https://togithub.com/vercel/turborepo/pull/1837) - fix(deps): update dependency eslint-plugin-react to v7.31.7 by [@​renovate](https://togithub.com/renovate) in [https://github.com/vercel/turborepo/pull/1834](https://togithub.com/vercel/turborepo/pull/1834) - chore(deps): update dependency [@​types/react](https://togithub.com/types/react) to v17.0.49 by [@​renovate](https://togithub.com/renovate) in [https://github.com/vercel/turborepo/pull/1833](https://togithub.com/vercel/turborepo/pull/1833) - Replace some 2 letter variables for readability by [@​mehulkar](https://togithub.com/mehulkar) in [https://github.com/vercel/turborepo/pull/1845](https://togithub.com/vercel/turborepo/pull/1845) ##### Documentation - Remove unused packages from docs site by [@​mehulkar](https://togithub.com/mehulkar) in [https://github.com/vercel/turborepo/pull/1828](https://togithub.com/vercel/turborepo/pull/1828) - Consolidated 'workspace' and 'package' terminology by [@​mattpocock](https://togithub.com/mattpocock) in [https://github.com/vercel/turborepo/pull/1817](https://togithub.com/vercel/turborepo/pull/1817) - Rewrote docs homepage by [@​mattpocock](https://togithub.com/mattpocock) in [https://github.com/vercel/turborepo/pull/1756](https://togithub.com/vercel/turborepo/pull/1756) - Update existing-monorepo.mdx by [@​shemayas](https://togithub.com/shemayas) in [https://github.com/vercel/turborepo/pull/1858](https://togithub.com/vercel/turborepo/pull/1858) - Update Docs by [@​PhentomPT](https://togithub.com/PhentomPT) in [https://github.com/vercel/turborepo/pull/1794](https://togithub.com/vercel/turborepo/pull/1794) - Fix broken links on "Add to existing Monorepo" by [@​pakaponk](https://togithub.com/pakaponk) in [https://github.com/vercel/turborepo/pull/1836](https://togithub.com/vercel/turborepo/pull/1836) ##### Examples - Removed parallel flag from basic example by [@​mattpocock](https://togithub.com/mattpocock) in [https://github.com/vercel/turborepo/pull/1787](https://togithub.com/vercel/turborepo/pull/1787) - Renamed storybook components by [@​samuelhorn](https://togithub.com/samuelhorn) in [https://github.com/vercel/turborepo/pull/1841](https://togithub.com/vercel/turborepo/pull/1841) ##### Packages - fix(eslint): exclude variables in rule by [@​tknickman](https://togithub.com/tknickman) in [https://github.com/vercel/turborepo/pull/1865](https://togithub.com/vercel/turborepo/pull/1865) #### New Contributors - [@​shemayas](https://togithub.com/shemayas) made their first contribution in [https://github.com/vercel/turborepo/pull/1858](https://togithub.com/vercel/turborepo/pull/1858) - [@​7flash](https://togithub.com/7flash) made their first contribution in [https://github.com/vercel/turborepo/pull/1837](https://togithub.com/vercel/turborepo/pull/1837) - [@​PhentomPT](https://togithub.com/PhentomPT) made their first contribution in [https://github.com/vercel/turborepo/pull/1794](https://togithub.com/vercel/turborepo/pull/1794) **Full Changelog**: vercel/turborepo@v1.4.5...v1.4.6 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/DeFiCh/metachain). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzMi4xOTQuMyIsInVwZGF0ZWRJblZlciI6IjMyLjE5NC4zIn0=--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
pr: automerge
Kodiak will merge these automatically after checks pass
pr: chore
A task that needs to be done (neither feature or bug)
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.
While working on another task (#1832), I found several things hard to read because of
short variable names. Although types and "Go to Definition" helps in these
cases, long function blocks and large files make it dfficult to focus on the task at hand.
For example, in some cases, the variable
ht
andth
appear side byside in the same block!
This commit replaces some of these names to improve general readability
(and also to reduce the diff in future behavior-changing work).