You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains 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
"Ensure that all variables and functions have descriptive names."
Description
This PR addresses the issue of having non-descriptive names for variables and functions in the codebase. It includes renaming variables and functions in the following files:
packages/squiggle-lang/src/fr/danger.ts
packages/squiggle-lang/src/fr/list.ts
The changes aim to improve code readability and maintainability by using more descriptive names that accurately represent the purpose and functionality of the variables and functions.
Summary of Changes
In packages/squiggle-lang/src/fr/danger.ts:
Renamed the variable REArgumentError to RuntimeArgumentError.
Renamed the function combinations to generateCombinations.
Renamed the function allCombinations to generateAllCombinations.
In packages/squiggle-lang/src/fr/list.ts:
Renamed the function _assertInteger to validateInteger.
Renamed the function _assertValidArrayLength to validateArrayLength.
These changes improve the clarity and understandability of the codebase, making it easier to maintain and work with.
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
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.
PR Feedback (click)
I created this PR to address this rule:
"Ensure that all variables and functions have descriptive names."
Description
This PR addresses the issue of having non-descriptive names for variables and functions in the codebase. It includes renaming variables and functions in the following files:
packages/squiggle-lang/src/fr/danger.ts
packages/squiggle-lang/src/fr/list.ts
The changes aim to improve code readability and maintainability by using more descriptive names that accurately represent the purpose and functionality of the variables and functions.
Summary of Changes
In
packages/squiggle-lang/src/fr/danger.ts
:REArgumentError
toRuntimeArgumentError
.combinations
togenerateCombinations
.allCombinations
togenerateAllCombinations
.In
packages/squiggle-lang/src/fr/list.ts
:_assertInteger
tovalidateInteger
._assertValidArrayLength
tovalidateArrayLength
.These changes improve the clarity and understandability of the codebase, making it easier to maintain and work with.