New go fmt on doc comments

This commit is contained in:
Matt Joiner 2022-12-05 17:49:27 +11:00
parent 330d23be22
commit 50a665f278
No known key found for this signature in database
GPG Key ID: 6B990B8185E7F782
2 changed files with 20 additions and 19 deletions

34
doc.go
View File

@ -1,24 +1,24 @@
/* /*
Package torrent implements a torrent client. Goals include: Package torrent implements a torrent client. Goals include:
* Configurable data storage, such as file, mmap, and piece-based. - Configurable data storage, such as file, mmap, and piece-based.
* Downloading on demand: torrent.Reader will request only the data required to - Downloading on demand: torrent.Reader will request only the data required to
satisfy Reads, which is ideal for streaming and torrentfs. satisfy Reads, which is ideal for streaming and torrentfs.
BitTorrent features implemented include: BitTorrent features implemented include:
* Protocol obfuscation - Protocol obfuscation
* DHT - DHT
* uTP - uTP
* PEX - PEX
* Magnet links - Magnet links
* IP Blocklists - IP Blocklists
* Some IPv6 - Some IPv6
* HTTP and UDP tracker clients - HTTP and UDP tracker clients
* BEPs: - BEPs:
- 3: Basic BitTorrent protocol - 3: Basic BitTorrent protocol
- 5: DHT - 5: DHT
- 6: Fast Extension (have all/none only) - 6: Fast Extension (have all/none only)
- 7: IPv6 Tracker Extension - 7: IPv6 Tracker Extension
- 9: ut_metadata - 9: ut_metadata
- 10: Extension protocol - 10: Extension protocol
- 11: PEX - 11: PEX
- 12: Multitracker metadata extension - 12: Multitracker metadata extension

View File

@ -30,8 +30,9 @@ type TorrentImpl struct {
} }
// Interacts with torrent piece data. Optional interfaces to implement include: // Interacts with torrent piece data. Optional interfaces to implement include:
// io.WriterTo, such as when a piece supports a more efficient way to write out incomplete chunks. //
// SelfHashing, such as when a piece supports a more efficient way to hash its contents. // io.WriterTo, such as when a piece supports a more efficient way to write out incomplete chunks.
// SelfHashing, such as when a piece supports a more efficient way to hash its contents.
type PieceImpl interface { type PieceImpl interface {
// These interfaces are not as strict as normally required. They can // These interfaces are not as strict as normally required. They can
// assume that the parameters are appropriate for the dimensions of the // assume that the parameters are appropriate for the dimensions of the