Skip to content

Commit

Permalink
[docs] fix headings in godoc (#5222)
Browse files Browse the repository at this point in the history
The documentation used `======` incorrectly to mark headings. According to godocs:

> A title is a line that is separated from its following line by an empty line, begins with a capital letter and doesn't end with punctuation.
  • Loading branch information
Alex Boten authored Apr 14, 2022
1 parent d8cc62b commit ac9eb92
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions component/receiver.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import (
// to by calling the nextConsumer.Consume*() function.
//
// Error Handling
// ==============
//
// The nextConsumer.Consume*() function may return an error to indicate that the data
// was not accepted. There are 2 types of possible errors: Permanent and non-Permanent.
// The receiver must check the type of the error using IsPermanent() helper.
Expand All @@ -50,7 +50,7 @@ import (
// is returned.
//
// Acknowledgment Handling
// =======================
//
// The receivers that receive data via a network protocol that support acknowledgments
// MUST follow this order of operations:
// - Receive data from some sender (typically from a network).
Expand Down

0 comments on commit ac9eb92

Please sign in to comment.