Make public <--> private functions consistent
WillemWybo opened this issue · comments
I guess functions prefixed by an underscore are not shown in the web reference? Just realized there are a lot of functions the user shouldn't call that don't have an underscore yet. Will look into changing this.
On the other hand, some functions that modify the behaviour under iteration or copying (i.e. __iter__ or __copy__) also don't show up, but implement important behaviours that should be documented. Is it possible to show the ones that have a docstring @benelot ?
Looks like you can do that by mentioning them in the docstring somehow, but we should test that.
https://stackoverflow.com/a/6106855/4563947
Ah ok, will give it a try!
I can't get the stackoverflow method to work. But I guess the point is moot if we handpick the functions that will be in reference?
Yes, we can just handpick them and it should work. Check #46 for an example that I added in the PR.
Solved by hand-picking functions to be added