godoc: Add 'Unordered' labels to output blocks for Examples. #441
Conversation
This change adds the "Unordered Output" label to examples that are marked as such. This makes it clear that the output will not necessarily be in a determined order from a given operation.
|
Unordered Output was added to examples in 2016, specifically allowing Example functions to define expected output, however mark it as not having a determined order (see the discussion here golang/go#10149). The actual go change was implemented in 2016 (https://go-review.googlesource.com/c/go/+/19280) along with a change to godoc to show the Unordered label in the Output section (https://go-review.googlesource.com/c/tools/+/20458) however the godoc change broke basically everybody not running head at that time since godoc was attempting to use a field in a structure that only existed in the previous commit. The changes in godoc were reverted and the intention was to wait long enough for go users to have all successfully upgraded to a release that contains the new field. That was 7 years ago. The field was included in go1.7 which means the vast majority of godoc users will have upgraded by now. Hopefully its now safe to try this again. |
|
This PR (HEAD: fa407a8) has been imported to Gerrit for code review. Please visit https://go-review.googlesource.com/c/tools/+/505475 to see it. Tip: You can toggle comments from me using the |
This change adds the "Unordered Output" label to examples that
are marked as such. This makes it clear that the output will
not necessarily be in a determined order from a given operation.