Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.
Sign upPublic/private view #43
Comments
This comment has been minimized.
This comment has been minimized.
|
@Hibou57 Thank you for your recent flurry of activity. I've seen some of it, but I probably won't have time to review it more closely for at least another week. With that said, I'm unlikely to support a public/private view. It's a corner case IMO and I want to resist increasing the size of |
This comment has been minimized.
This comment has been minimized.
|
OK, I see. So I guess patch-3 named “Adding a local modules list” will not be good. In the future, I may just propose this kind of patches to my fork only and not make pull-request for these ones. |
This comment has been minimized.
This comment has been minimized.
|
I think for now pdoc will remain focused on providing excellent, clean documentation for a public API. Thanks! |
Hibou57 commentedMar 14, 2015
I patched my local installation so that is provides either a public view or a private view of a module.
The rational is that it's useful to see the documentation of a module's private items to review/work-with/understand it.
I'm using a query string for this:
?private=falseor?private=true. I would like to know if it seems OK to use a query string or if the option should appears in the base URL.I will wait for the review of the already pending pull-requests before I add this patch to my fork and do a pull-request from it.
Also just wanted to say I like pdoc, it really helps me, although I had to fix it in multiple ways (my issue is that I don't really know if my fixes are required to me only or if they are of interest to some others too).