ponyc icon indicating copy to clipboard operation
ponyc copied to clipboard

Docs generation always includes imported packages

Open EpicEric opened this issue 7 years ago • 3 comments

If I have a Pony program with a use statement, all code from other packages will be included in code documentation generation. Running ponyc mypkg --docs --pass docs on the following code:

use "collections"

class MyClass
  ...

will generate docs for mypkg, builtin, and collections. This is also the case for packages in Stable environments, and other packages that these packages include.

I understand how this is necessary for the stdlib, since it generates the docs for all packages through use statements. However, regular users are only interested in generating documentation of their own libraries. There should be some way to specify for which packages documentation should be generated, or at least the --docs flag description should be changed to describe this behaviour.

EpicEric avatar Jun 10 '18 22:06 EpicEric