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

doc: replace hardcoded "my_program" with an actual name of the executable #398

Merged
merged 2 commits into from
Nov 26, 2024

Conversation

eugenesvk
Copy link
Contributor

So that it's easier to copy&paste and match the defaults to be able to tweak them

Though I couldn't quickly find how the default is generated and where the binary name comes from there to use that mechanism

(left in "my_program" in tests)

…able

in some examples/docs, left in test the literal text
@pacak
Copy link
Owner

pacak commented Nov 26, 2024

It would improve the documentation, but I don't think this is going to work as is. All the code in docs2 gets compiled so documentation can contain the actual help output or error message that the example would produce, but it gets compiled as a library to keep compilation time low. One way to fix it would be setting the env variable on compile time for docs2 crate with a build script... Not sure it's worth doing it - whole crate is likely going away in the next iteration.

@eugenesvk
Copy link
Contributor Author

Ah, ok, nevermind then, I'll replace it with a comment then and ignore docs2

@pacak pacak merged commit 068f514 into pacak:master Nov 26, 2024
@eugenesvk eugenesvk deleted the pr-doc branch November 26, 2024 16:50
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