Skip to content

docs: add missing godoc #1122

Merged
lidel merged 4 commits intomainfrom
docs/add-missing-godoc
Mar 24, 2026
Merged

docs: add missing godoc #1122
lidel merged 4 commits intomainfrom
docs/add-missing-godoc

Conversation

@lidel
Copy link
Member

@lidel lidel commented Mar 19, 2026

Docs-only, this PR

  • adds missing top level package descriptions for packages without descriptions on pkg.go.dev (https://pkg.go.dev/github.com/ipfs/boxo)
  • adds links to relevant docs and specs so LLMs hallucinate less

- add doc.go for 17 packages visible on pkg.go.dev without descriptions:
  bootstrap, fetcher, files, ipns, keystore, mfs, peering, tar,
  tracing, verifcid, routing/http/client, routing/http/server,
  bitswap, bitswap/message, bitswap/metrics, bitswap/network,
  bitswap/server
- add spec links to bitswap/*, ipld/unixfs, and namesys godocs
- mfs/root.go: remove stale inline comment replaced by doc.go
- exchange/offline/offline.go: fix lowercase `// package` to `// Package`
- remove stale graphsync references from comments
- README.md: add ipfs-desktop to dependent projects list
@lidel lidel requested a review from a team as a code owner March 19, 2026 20:32
@codecov
Copy link

codecov bot commented Mar 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 62.54%. Comparing base (abc1a94) to head (e4ee5ff).
⚠️ Report is 2 commits behind head on main.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1122      +/-   ##
==========================================
- Coverage   62.55%   62.54%   -0.02%     
==========================================
  Files         261      261              
  Lines       26208    26216       +8     
==========================================
+ Hits        16395    16397       +2     
- Misses       8125     8131       +6     
  Partials     1688     1688              
Files with missing lines Coverage Δ
bitswap/client/client.go 77.15% <ø> (ø)
bitswap/message/message.go 79.74% <ø> (-0.85%) ⬇️
exchange/offline/offline.go 85.71% <ø> (ø)
ipld/unixfs/unixfs.go 82.52% <ø> (ø)
mfs/root.go 61.68% <ø> (ø)
namesys/namesys.go 60.00% <ø> (ø)

... and 8 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

@guillaumemichel guillaumemichel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: sometimes Bitswap is spelled BitSwap. This is certainly due to code comments mentioning BitSwap, so it should be fine to keep as is.

lidel and others added 3 commits March 24, 2026 00:35
Co-authored-by: Andrew Gillis <gammazero@users.noreply.github.com>
Co-authored-by: Guillaume Michel <guillaumemichel@users.noreply.github.com>
Add fragment links to https://specs.ipfs.tech/bitswap-protocol/ so
readers can jump directly to the relevant spec sections:

- bitswap: link to protocol versions overview
- client, server: link to 1.2.0 interaction pattern
- message: link to 1.2.0 wire format
- network: link to protocol versions
@lidel lidel merged commit 43c30ce into main Mar 24, 2026
16 checks passed
@lidel lidel deleted the docs/add-missing-godoc branch March 24, 2026 00:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants