Skip to content

Commit ca5f826

Browse files
committed
Remove implicit/explicit heading auto-formatting
See #895 (comment) > Before Go 1.19, headings were identified implicitly by single-line paragraphs satisfying certain conditions, most notably the lack of any terminating punctuation. > > Gofmt reformats [lines treated as implicit headings](https://github.com/golang/proposal/blob/master/design/51082-godocfmt.md#headings) by earlier versions of Go to use # headings instead. If the reformatting is not appropriate—that is, if the line was not meant to be a heading—the easiest way to make it a paragraph is to introduce terminating punctuation such as a period or colon, or to break it into two lines. > > *-- https://go.dev/doc/comment#headings*
1 parent 0bc0466 commit ca5f826

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

tests/msc3902/federation_room_join_partial_state_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4287,7 +4287,7 @@ type partialStateJoinResult struct {
42874287

42884288
// beginPartialStateJoin has a test user attempt to join the given room.
42894289
//
4290-
// # It returns a partialStateJoinResult
4290+
// It returns a partialStateJoinResult.
42914291
//
42924292
// When this method completes, the /join request will have completed, but the
42934293
// state has not yet been re-synced. To allow the re-sync to proceed, call

0 commit comments

Comments
 (0)