-
Notifications
You must be signed in to change notification settings - Fork 3k
docs: add support for ref-man man-pages #10237
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
base: maint
Are you sure you want to change the base?
docs: add support for ref-man man-pages #10237
Conversation
CT Test Results 4 files 228 suites 1h 57m 43s ⏱️ Results for commit eb40e71. ♻️ This comment has been updated with latest results. To speed up review, make sure that you have read Contributing to Erlang/OTP and that all checks pass. See the TESTING and DEVELOPMENT HowTo guides for details about how to run test locally. Artifacts// Erlang/OTP Github Action Bot |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe we should add tests, similar to shell_docs_SUITE
with the function docsmap
.
Essentially, we want to test that we do not crash if we generate all man pages.
The main reason is that we may not crash when we test locally, but we may add some unsupported markdown that generates a new markdown AST node, and that one crashes the man page generation.
lib/stdlib/src/shell_docs.erl
Outdated
render_type(Module, D, #{}). | ||
|
||
%% extract AST raw type specifications. | ||
-spec extract_type_specs(atom()) -> term(). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-spec extract_type_specs(atom()) -> term(). | |
-spec extract_type_specs(module()) -> map(). |
87c21c1
to
a930d0c
Compare
a930d0c
to
55121ed
Compare
2c9753b
to
fb8d2ca
Compare
fb8d2ca
to
eb40e71
Compare
No description provided.