tecosaur / CheckDoc.jl

Documentation linting
MIT License
6 stars 1 forks source link

All referenced bindings should be public #2

Open jariji opened 4 months ago

jariji commented 4 months ago

I often seen documentation suggest using some function P.f() which isn't public. I think this is best avoided and could probably be detected by a linter.

tecosaur commented 3 months ago

I think the tough thing here is differentiating between the different ways that private functions are referenced, say "for more information, look at Foo.private" where it's not suggested it be used, or "if you need X, see Foo.private".