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

feature: manual entry #66

Open
bswck opened this issue Jan 12, 2024 · 2 comments
Open

feature: manual entry #66

bswck opened this issue Jan 12, 2024 · 2 comments
Assignees
Labels
feature New feature or request fund Issue priority can be boosted

Comments

@bswck
Copy link

bswck commented Jan 12, 2024

Is your feature request related to a problem? Please describe.

git changelog --help

results in

No manual entry for git-changelog

I believe it would be nice to see a manual when prompted git changelog with --help.
Especially since it's pretty much ready: https://github.com/pawamoy/git-changelog#usage-command-line.

Describe the solution you'd like

Release git changelog extension with a man page.

Describe alternatives you've considered

Ignore this feature request.

Additional context

I love git changelog!

Boost priority

  • Boost priority in our backlog through Polar.sh. Higher pledge, higher priority.
  • Minimum pledge by user/organization is $5, minimum amount for boost is $30.
  • View all issues with pledges.
  • We receive the funds once the issue is completed and confirmed by you.
  • Features with the insiders label are released to sponsors first, and tied to a funding goal.
Fund with Polar
@pawamoy
Copy link
Owner

pawamoy commented Jan 12, 2024

❤️ ❤️

I'm all for distributing manual pages alongside Python packages, but I believe there is no standard way to do that. Or maybe you know how to do it?

I've seen possible solutions like including manual pages with setuptools' data_files or Hatch's shared-data, but even with that, tools like pip simply do not know how/where to install them. Every user would have to set their MANPATH to every man directory contained in every virtualenv or Python site-packages on their system. That's not automated.

@pawamoy pawamoy added docs Improvements or additions to documentation fund Issue priority can be boosted labels Oct 25, 2024
@pawamoy pawamoy added feature New feature or request and removed docs Improvements or additions to documentation labels Dec 3, 2024
@pawamoy
Copy link
Owner

pawamoy commented Dec 3, 2024

My copier-uv template already adds the relevant files to sdist/wheels. Just need to write a man page now and wait for uv to support them like pipx does.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request fund Issue priority can be boosted
Projects
None yet
Development

No branches or pull requests

2 participants