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.

Sign up for GitHub

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

Jump to bottom

Do not document buggy behavior. #49325

Merged
merged 1 commit into from Nov 30, 2018
Merged

Do not document buggy behavior. #49325

merged 1 commit into from Nov 30, 2018

Conversation

pillarsdotnet
Copy link
Contributor

Per @abadger remarks in #43256, we should avoid documenting buggy behavior.

+label: docsite_pr

SUMMARY

Remove documentation that supplying an integer for the pip umask option "works, but was almost certainly not what was intended."

Fixes #43256

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

pip

@pillarsdotnet
Do not document buggy behavior.
1b77d72 
Note that the umask should be specified as an octal *string*, not an octal (or decimal) *integer*.

+label: docsite_pr
This was referenced Nov 29, 2018
Merged
Closed
@ansibot
Copy link
Contributor

ansibot commented Nov 29, 2018

Hi @pillarsdotnet, thank you for submitting this pull-request!

click here for bot help

@ansibot
Copy link
Contributor

ansibot commented Nov 29, 2018

cc @Lujeni @mattupstate @webknjaz
click here for bot help

@ansibot ansibot added affects_2.8 This issue/PR affects Ansible v2.8 core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. module This issue/PR relates to a module. needs_triage Needs a first human triage before being processed. small_patch support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Nov 29, 2018
@acozine acozine merged commit 2557373 into ansible:devel Nov 30, 2018
acozine pushed a commit that referenced this pull request Nov 30, 2018
@pillarsdotnet @acozine
Improve pip umask docs (#49146, #49325) (#49326)
9a5a4fa 
* For the pip module, umask should be specified as an octal *string*, not an octal (or decimal) *integer*.
(cherry picked from commit 0521e1c)
(cherry picked from commit 237f127)

* Do not document buggy behavior.
(cherry picked from commit 1b77d72)
@samdoran samdoran removed the needs_triage Needs a first human triage before being processed. label Dec 4, 2018
@dagwieers dagwieers added the docsite_pr This PR is created from documentation using the "Edit on GitHub" link. label Dec 10, 2018
@dagwieers
Copy link
Contributor

I don't agree with removing this, as long as people could be writing it as an integer they might end up with unexpected results and the documentation now lacks information.

Maybe the wording could be better, and maybe it should be a note, rather than part of the parameter description, but we do need to warn/inform users about this. Pretending there is no issue when there is, is worse from a support perspective.

cc: @abadger

@dagwieers
Copy link
Contributor

@pillarsdotnet @abadger I implemented my proposal above. I introduced a newer type mode that currently provides a deprecation warning if your mode or directory_mode parameter returns anything but a string.

You can find the PR here: #50035

Also, this PR cleans up a lot of examples doing it wrong.

kbreit pushed a commit to kbreit/ansible that referenced this pull request Jan 11, 2019
@pillarsdotnet @kbreit
Do not document buggy behavior. (ansible#49325)
0b7b0a2 
In the pip module, umask should be specified as an octal *string*, not an octal (or decimal) *integer*.
@ansible ansible locked and limited conversation to collaborators Jul 22, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@abadger abadger Awaiting requested review from abadger

Assignees
No one assigned
Labels
affects_2.8 This issue/PR affects Ansible v2.8 core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. docsite_pr This PR is created from documentation using the "Edit on GitHub" link. module This issue/PR relates to a module. small_patch support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

pip umask parameter does not work with octal (int) umask values
5 participants
@pillarsdotnet @ansibot @dagwieers @acozine @samdoran