rays/ipx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 18 Wiki Activity

Rust: ipx-feed and ipx-directory have public items without doc comments #354

New Issue
Closed
opened 2026-10-23 18:00:03 -07:00 by rays · 2 comments
rays commented 2026-10-23 18:00:03 -07:00
Owner
Copy Link

The style guide asks for doc comments on public APIs. ipx-feed (used by ipx and the directory) has about 12 pub items without one and ipx-directory's library about 20 (2026-10-24). ipx itself is a binary, so its pub items are not a public API.

The style guide asks for doc comments on public APIs. ipx-feed (used by ipx and the directory) has about 12 `pub` items without one and ipx-directory's library about 20 (2026-10-24). ipx itself is a binary, so its `pub` items are not a public API.
rays added the enhancement label 2026-10-23 18:00:03 -07:00
rays commented 2026-10-23 18:12:03 -07:00
Author
Owner
Copy Link

Done in 41affc8: every exported type, function, constant and static of ipx-feed and ipx-directory has a doc comment; self-explanatory fields and variants do not, as the guide allows. Also moved category_path's misplaced comment back to it.

Done in 41affc8: every exported type, function, constant and static of ipx-feed and ipx-directory has a doc comment; self-explanatory fields and variants do not, as the guide allows. Also moved category_path's misplaced comment back to it.
rays closed this issue 2026-10-23 18:12:04 -07:00
rays commented 2026-10-23 18:12:27 -07:00
Author
Owner
Copy Link

Correction: the commit is d33d830, not 41affc8 as the comment above says (the first attempt was refused by the pre-commit hook for formatting).

Correction: the commit is d33d830, not 41affc8 as the comment above says (the first attempt was refused by the pre-commit hook for formatting).
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
Something is not working
 duplicate
This issue or pull request already exists
 enhancement
New feature
 help wanted
Need some help
 invalid
Something is wrong
 question
More information is needed
 wontfix
This won't be fixed
No Label enhancement
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
rays
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: rays/ipx#354
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?