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.

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

Unify options to use camelCase and document each option #695

Closed
wants to merge 6 commits into from

Conversation

oetr
Copy link
Contributor

@oetr oetr commented Nov 10, 2023

This PR unifies the option names for CLI and Jest to camelCase. The old way of using snake_case options on CLI are still available.

Thi PR also improves the documentation:

  • each option are described in detail in every configuration in which it's usable
  • at least one example is given for every option/configuration combo

@oetr oetr requested a review from a team November 10, 2023 13:59
@oetr oetr changed the title Unify options to use camelCase; document each option Unify options to use camelCase and document each option Nov 10, 2023
Copy link
Contributor

@bertschneider bertschneider left a comment

Choose a reason for hiding this comment

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

Badly needed docs update! Thx.
Just some minor suggestions.

packages/core/cli.ts Show resolved Hide resolved
packages/jest-runner/fuzz.ts Show resolved Hide resolved
docs/fuzz-settings.md Show resolved Hide resolved
docs/fuzz-settings.md Show resolved Hide resolved
docs/fuzz-settings.md Show resolved Hide resolved
docs/fuzz-settings.md Show resolved Hide resolved
docs/fuzz-settings.md Show resolved Hide resolved
docs/fuzz-settings.md Show resolved Hide resolved
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.

None yet

2 participants