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
Currently for each module passed to makedocs will all submodules recursively defined and added to the list of modules checked by missingdocs.
I have a few modules which vendored into my package. e.g. if a small dependency is not externally maintained/hasn't got around to merging a PR. These modules are meant to be transitional and the hope is they might be removed at some point. They are not part of the public interface, but I don't want to go through and strip the docs.
I'm not sure what the best solution is. Perhaps some parts of the subtree can be excluded with a internal_modules argument?
This is a bit more relevant with the new strict=true behaviour. There should be a more granular way of turning off this warning/error: #2051
Related to this is efforts to have some degree of public/private added to Julia which might help JuliaLang/julia#50105
The text was updated successfully, but these errors were encountered:
So, the current standard way to work around this is to include all the internal docstrings on an internals page with at-autodocs. But I agree, that's not necessarily ideal.
I think I would be okay with a internal_modules / missingdocs_exclude keyword where you list the modules you don't want checked. Two questions that I have:
Are you still allowed to include docstrings from those modules? I.e. is it declaring the module "internal" and therefore should not be included? Or is it just excluding them from this check?
This would have module-level granularity. But maybe there's some more general API we could devise here? User-provided predicate that gets called with each (missing) docstring?
Also, in general, allowing more fine-grained control over the errors would always be good, so API suggestions in that directions would be very welcome too.
Currently for each module passed to
makedocs
will all submodules recursively defined and added to the list of modules checked by missingdocs.I have a few modules which vendored into my package. e.g. if a small dependency is not externally maintained/hasn't got around to merging a PR. These modules are meant to be transitional and the hope is they might be removed at some point. They are not part of the public interface, but I don't want to go through and strip the docs.
I'm not sure what the best solution is. Perhaps some parts of the subtree can be excluded with a
internal_modules
argument?This is a bit more relevant with the new strict=true behaviour. There should be a more granular way of turning off this warning/error: #2051
Related to this is efforts to have some degree of public/private added to Julia which might help JuliaLang/julia#50105
The text was updated successfully, but these errors were encountered: