go: os: ambiguous documentation of type FileMode

What version of Go are you using (go version)?

N/A

Does this issue reproduce with the latest release?

Yes ( latest document online )

What operating system and processor architecture are you using (go env)?

N/A

What did you do?

Read documentation of the FileMode bitfields

What did you expect to see?

Either

  • …The values of the lowest 9 bits should be considered part of the public API… OR
  • …The values of any of the 32 bits already defined in the const listing below should be considered part of the public API…

What did you see instead?

  • …The values of these bits should be considered part of the public API…

The documentation as currently written is clearly open to interpretation. Further discussion: https://botbot.me/freenode/go-nuts/2018-05-16/?msg=100120706&page=5

About this issue

  • Original URL
  • State: open
  • Created 6 years ago
  • Reactions: 1
  • Comments: 16 (7 by maintainers)

Most upvoted comments

You’re right, I’m confused too. The text in https://github.com/golang/go/issues/25422#issuecomment-410436836 looks more or less correct. The text in https://github.com/golang/go/issues/25422#issuecomment-496059067 looks misleading. I was reading the latter comment out of context.