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

[Merged by Bors] - Update docstring of squeeze_one_norm' #8667

Closed
wants to merge 2 commits into from

Conversation

adomasbaliuka
Copy link
Collaborator

@adomasbaliuka adomasbaliuka commented Nov 27, 2023

squeeze_one_norm' and squeeze_zero_norm' had the same docstring. The docstring of squeeze_zero_norm' was strictly speaking incorrect (writing 1 instead of 0).

The docstring of squeeze_one_norm' was correct but perhaps this change makes it easier for people to notice the difference and what E is.


Open in Gitpod

`squeeze_one_norm'` and `squeeze_zero_norm'` had the same docstring. The docstring of `squeeze_one_norm'` was strictly speaking incorrect (writing `0` instead of `1`).

The docstring of `squeeze_one_norm'` is correct but perhaps this change makes it less likely to be misunderstood by people missing what `E` is.
@adomasbaliuka adomasbaliuka added easy < 20s of review time. See the lifecycle page for guidelines. new-contributor This PR was made by a contributor with at most 5 merged PRs. Welcome to the community! labels Nov 27, 2023
@j-loreaux
Copy link
Collaborator

Thanks!

bors merge

mathlib-bors bot pushed a commit that referenced this pull request Nov 28, 2023
`squeeze_one_norm'` and `squeeze_zero_norm'` had the same docstring. The docstring of `squeeze_zero_norm'` was strictly speaking incorrect (writing `1` instead of `0`).

The docstring of `squeeze_one_norm'` was correct but perhaps this change makes it easier for people to notice the difference and what `E` is.
@mathlib-bors
Copy link
Contributor

mathlib-bors bot commented Nov 28, 2023

Pull request successfully merged into master.

Build succeeded:

@mathlib-bors mathlib-bors bot changed the title Update docstring of squeeze_one_norm' [Merged by Bors] - Update docstring of squeeze_one_norm' Nov 28, 2023
@mathlib-bors mathlib-bors bot closed this Nov 28, 2023
@mathlib-bors mathlib-bors bot deleted the adomasbaliuka-patch-1 branch November 28, 2023 01:43
awueth pushed a commit that referenced this pull request Dec 19, 2023
`squeeze_one_norm'` and `squeeze_zero_norm'` had the same docstring. The docstring of `squeeze_zero_norm'` was strictly speaking incorrect (writing `1` instead of `0`).

The docstring of `squeeze_one_norm'` was correct but perhaps this change makes it easier for people to notice the difference and what `E` is.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
easy < 20s of review time. See the lifecycle page for guidelines. new-contributor This PR was made by a contributor with at most 5 merged PRs. Welcome to the community!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants