Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SR-15314] [Swift-DocC] Improve help information for docc index command #228

Closed
ethan-kusters opened this issue Oct 13, 2021 · 1 comment
Closed
Labels
bug

Comments

@ethan-kusters
Copy link
Contributor

@ethan-kusters ethan-kusters commented Oct 13, 2021

Previous ID SR-15314
Radar rdar://68701016
Original Reporter @ethan-kusters
Type Bug
Status Resolved
Resolution Done
Additional Detail from JIRA
Votes 0
Component/s Swift-DocC
Labels Bug, StarterBug
Assignee maldahleh (JIRA)
Priority Medium

md5: c4c6583d1092b3d462a1a4eacca43836

Issue Description:

The help information emitted for the docc index subcommand instructs the user to provide a .docc catalog as input. The command actually expects a Data folder of render JSON files from a compiled documentation archive. We should update the help information to reflect this.

Currently this is what docc emits for ‘docc index --help’:

OVERVIEW: Create an index for the documentation from compiled data.

USAGE: docc index <source-bundle-path> -bundle-identifier <bundle-identifier> [-verbose]

ARGUMENTS:
<source-bundle-path> Path to a documentation bundle directory.
The '.docc' bundle docc will build.

@d-ronnqvist
Copy link
Contributor

@d-ronnqvist d-ronnqvist commented Oct 27, 2021

The PR that fix this issue was merged here #10

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
@shahmishal shahmishal transferred this issue from apple/swift May 3, 2022
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug
Projects
None yet
Development

No branches or pull requests

2 participants