ipython / ipython/traitlets

Generate manpage from configuration options

Đang mở
#636 1 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
Python
Star
653
Fork
217
Merge trung bình
2 ngày 21 giờ
Pull request đã merge (30 ngày)
2

Mô tả

In https://github.com/jupyter/jupyter_server/issues/320, @SnarkBoojum submitted a manpage for Jupyter Server that largely encoded the results from `--help`. We realized that it would make more sense to have an automatically generated manpage at the traitlet level from the configurable traits. This issue is about adding a `--generate-manpage` option, or perhaps a separate manpage generation command, that does something similar to `-h`, but generates the output as a manpage.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Start by tracing how configurable traits produce the existing `-h` output and how a command-line option or separate command would fit at the traitlet level. Define whether `--generate-manpage` or a separate command is the intended interface, then verify that the generated output captures the configurable options in manpage form.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
cli
Loại issue
Tính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
25/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.