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

Enable -out:<filename> for doc subcommand #4231

Merged
merged 1 commit into from
Sep 11, 2024

Conversation

InKryption
Copy link
Contributor

@InKryption InKryption commented Sep 11, 2024

The logic for writing the .odin-doc file to the value assigned to out_filepath already exists, this just enables it on the CLI frontend.

@Kelimion
Copy link
Member

The way I read this code, it would take the path given in -out as a base and still append .odin-doc to it? So perhaps the help text should reflect that -out:foo would create a documentation file called foo.odin-doc.

image

@InKryption
Copy link
Contributor Author

To be clear, it always outputs a file named. Ie -out:<filename> produces <filename>.odin-doc, and -out:<filename>.odin-doc produces the same.

@Kelimion
Copy link
Member

Kelimion commented Sep 11, 2024

Yes. My point is that -out allows you to specify the base name. The extension - if present - will be stripped and replaced, so it would be useful for the help text to reflect that it allows you to set the base name, in case it leads them to believe that -out:foo.bar would generate a doc file called foo.bar.

@InKryption
Copy link
Contributor Author

Will address when I get off my flight

The logic for writing the .odin-doc file to the value assigned
to out_filepath already exists, this just enables it on the CLI
frontend.
@Kelimion Kelimion merged commit c94829f into odin-lang:master Sep 11, 2024
7 checks passed
@InKryption InKryption deleted the enable-doc-out-param branch September 12, 2024 00:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants