You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
require"json"moduleJSON::ANewModule# some documentation heredeftestendend
Then run the document generation
crystal docs && open docs/index.html
Expectation: Documentation is generated for JSON::ANewModule object
Result: The class/module is ignored at all in the documentation and doesn't exists.
The text was updated successfully, but these errors were encountered:
The issue is probably that the documentation generator filters at the top level which namespaces are to be included into the documentation. Since JSON is not reopened in user code, it doesn't qualify and ass such, the entire tree including JSON::ANewModule is not included.
When we change that, there's a question which behaviour we'd expect. Should the documentation include all of JSON namespace, or just JSON::ANewModule?
I suppose the latter is better. When necessary, you can include the entire namespace using a different means (see #8550).
I've wrote about it on the forum here
Reproducible code:
src/ext.cr
Then run the document generation
crystal docs && open docs/index.html
Expectation: Documentation is generated for JSON::ANewModule object
Result: The class/module is ignored at all in the documentation and doesn't exists.
The text was updated successfully, but these errors were encountered: