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

Rename horizons to auto-sample-conditions #225

Merged
merged 1 commit into from
Sep 27, 2021
Merged

Rename horizons to auto-sample-conditions #225

merged 1 commit into from
Sep 27, 2021

Conversation

aomarks
Copy link
Member

@aomarks aomarks commented Sep 25, 2021

I never liked the name "horizons" (except on the day I chose it I guess). I think a much clearer name is "auto sample conditions".

This changes the --horizon flag and the horizons JSON config setting (yes... one was singular, the other plural) to --auto-sample-conditions and autoSampleConditions respectively.

It's backwards compatible, with a warning printed if you use the old style.

Related to #221

Copy link
Collaborator

@AndrewJakubowicz AndrewJakubowicz left a comment

Choose a reason for hiding this comment

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

I didn't manually check anything, but the documentation and naming changes look fantastic. They're definitely much clearer. Great test updates as well!

Only tiny optional nits.

🎉

| `0.5ms` | Is A faster or slower than B by at least 0.5 milliseconds? |

In the following example, we have set `--horizon=10%`, meaning we are interested
### Auto sample conditions
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nit: Maybe both? "Auto sample stopping conditions" - unless conditions can do more than just stop? Also no action required.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think I'd like to be 100% consistent with the phrase "auto sample conditions".

README.md Outdated
conditions_. This is controlled by the `--auto-sample-conditions` flag or the
`autoSampleConditions` JSON config option.

An auto sample condition condition can be thought of as a point of interest on
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nit: condition intended twice?

Copy link
Member Author

Choose a reason for hiding this comment

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

Nope! Thanks, fixed.

Choose a reason for hiding this comment

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

Nit: condition intended twice?

"items": {
"type": "string"
},
"type": "array"
Copy link
Collaborator

Choose a reason for hiding this comment

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

👏 Very helpful!

@@ -768,6 +768,22 @@ suite('config', () => {
'config.benchmarks[0].packageVersions requires property "label"'
);
});

test('Error to use both horizons and autoSampleConditions', async () => {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nice!

Base automatically changed from readme-improvements to main September 27, 2021 21:06
@aomarks aomarks merged commit 19fc355 into main Sep 27, 2021
@aomarks aomarks deleted the rename-horizons branch September 27, 2021 21:16
@Eldeloro1
Copy link

I never liked the name "horizons" (except on the day I chose it I guess). I think a much clearer name is "auto sample conditions".

This changes the --horizon flag and the horizons JSON config setting (yes... one was singular, the other plural) to --auto-sample-conditions and autoSampleConditions respectively.

It's backwards compatible, with a warning printed if you use the old style.

Related to #221

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants