std::io::Seek's documentation about seeking beyond the end of a stream is confusing

[Xpyder]

https://doc.rust-lang.org/std/io/trait.Seek.html
std::io::Seek

I got confused by this line and wasted some people's time over on internals.rust

A seek beyond the end of a stream is allowed, but implementation defined.

so after a little discussion it seems like this might be better wording for those of us who are silly

A seek beyond the end of a stream is allowed, but it is implementation-defined.

The hyphen makes it clear “implementation defined” is a known concept (and matches it’s usage elsewhere) and the “it is” makes it a bit more clear that the full sentence is considered and intentional.

While normally I find brevity improves clarity, in this case if you don’t realize “implementation defined” is a single concept, it sounds like a thought that trailed off after an edit

[Xpyder]

Thanks @shepmaster, I know other projects I've worked with have Easy and Documentation as tags so I wasn't sure if you guys might do the same

[shepmaster]

Yep, they're just actual labels over on the right ;-) (I also tabbed away and forgot to put the easy label on immediately 😊)

[cuviper]

wasted some people's time

Don't worry about that! It's very easy for developers to misjudge whether such descriptions will make sense to the target users. Pointing these things out is a great way to contribute to documentation.