Skip to content
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

Documentation is not inherited from &hidden& classes #48

Closed
guyer opened this issue Sep 19, 2014 · 1 comment
Closed

Documentation is not inherited from &hidden& classes #48

guyer opened this issue Sep 19, 2014 · 1 comment

Comments

@guyer
Copy link
Member

guyer commented Sep 19, 2014

In the interests of making the documentation simpler to read, a great many of &internal& classes were &hidden& by prepending their names with '_'. The problem is that many public classes, e.g. ExponentialConvectionTerm, are derived from private classes, e.g. _ConvectionTerm and _FaceTerm. The private classes provide many methods that are crucial to using the public classes, but these are presently not documented. Either: (i) some epydoc setting needs to be found to cause these methods to be documented in the public classes. (ii) the &hidden& status of these classes needs to be re-evaluated.

Imported from trac ticket #49, created by jguyer on 06-27-2005 at 17:19, last modified: 01-11-2007 at 07:03

@guyer
Copy link
Member Author

guyer commented Sep 19, 2014

Logged In: YES user_id=121894 Abstract base classes have been made public as necessary.

Trac comment by jguyer on 09-02-2005 at 10:31

@guyer guyer closed this as completed Sep 19, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant