Comments (8)
@timofurrer I've opened #13 which solves one of the issues raised by this ticket.
from click-man.
Okay, wasn't aware of that.
I'm happy to review PRs 🎉
from click-man.
@timofurrer Thanks for such a quick response, I will attempt a PR as soon as I can.
from click-man.
@timofurrer Thanks for merging #13 so quickly!
I have other thoughts on how to handle whitespace (indentation) issues. It's simple enough to replace the 2 space indentation generated for commands by click-man with .RS and .RE. And I'd be happy to submit a PR to fix that.
Slightly trickier is whether clickman tries to convert indents in the source code to .RS and .RE. It could be attempted but wouldn't be fool proof since we'd have to assume what constitutes an indent level (i.e. 4 spaces). Is a PR for this something you'd be interested in or would it complicate the tool too much? I also think that if this were added it would perhaps also require additional user options to allow the user to specify the indent type i.e. indent-char=SPACE indent-width=4 or something like this to allow them to override the 4 space default. 🐠
from click-man.
@timofurrer Hey, I figure you may have missed this, or you may just be busy, either way this is just a reminder that I'd be curious to know if you have any thoughts on the above. 🐱
from click-man.
@timofurrer I don't know whether lack of a response here means I should attempt a PR or close this issue?
from click-man.
@richardipsum the lack of response is due to the lack of time I currently have - I'm sorry for that.
It's simple enough to replace the 2 space indentation generated for commands by click-man with .RS and .RE. And I'd be happy to submit a PR to fix that.
Sounds good 👍 Go for it!
Slightly trickier is whether clickman tries to convert indents in the source code to .RS and .RE. It could be attempted but wouldn't be fool proof since we'd have to assume what constitutes an indent level (i.e. 4 spaces). Is a PR for this something you'd be interested in or would it complicate the tool too much? I also think that if this were added it would perhaps also require additional user options to allow the user to specify the indent type i.e. indent-char=SPACE indent-width=4 or something like this to allow them to override the 4 space default. 🐠
I certainly see the problem. However, I'm struggling why you would want source code in the man page of a CLI tool. Maybe we should just strip source code from the man pages?
If we go for the indent in source code as well, we definitely have to allow the user to specify the level.
from click-man.
@richardipsum the lack of response is due to the lack of time I currently have - I'm sorry for that.
No worries, thanks for getting back to me.
It's simple enough to replace the 2 space indentation generated for commands by click-man with .RS and .RE. And I'd be happy to submit a PR to fix that.
Sounds good 👍 Go for it!
Cool, I'll prepare a PR
I certainly see the problem. However, I'm struggling why you would want source code in the man page of a CLI tool. Maybe we should just strip source code from the man pages?
If we go for the indent in source code as well, we definitely have to allow the user to specify the level.
Sorry I mean the comments in the source, which get used in man pages, should the tool attempt to convert any indentation in a comment into .RS .RE sequences?
from click-man.
Related Issues (20)
- Sub-commands manual not generated HOT 2
- Remove dependency on disutils Command? HOT 1
- Upload 0.2.2 to PyPI HOT 1
- Missing docstring raises cryptic error HOT 2
- AttributeError: 'function' object has no attribute 'allow_extra_args' HOT 6
- use click 7.0 Generate man pages report "AttributeError" HOT 1
- Use Jinja2 for base man page
- Man pages are generated for 'hidden' commands.
- Description on PyPI isn't formatted correctly HOT 2
- Formatted text in help text not rendered properly
- RFE: Be able to disable inclusion of date in generated manpage
- 0.4.0 release tarball naming, contents irregularity HOT 3
- Feature switches are not handled correctly
- Use unclear in non setuptools project HOT 2
- Add support for typer applications HOT 1
- Not reading dynamically added commands
- man page format broken in debian 12 HOT 1
- Man generation for CLI with hidden options is broken
- PyPI release 0.4.2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from click-man.