search

rdrr-io / rdrr-issues

rdrr.io issues
34 stars 7 forks source link

Consider only listing exported (i.e. "public" and "stable") functions in the "Global Functions" list? #30

Open trevorld opened 6 years ago

trevorld commented 6 years ago

I'm not sure people really need to see or consider using the non-exported "private" functions especially in production situations since there should be no expectation that non-exported (and often non-documented) "private" function API's should be kept stable whereas there should be an expectation (once package reaches 1.0) that the exported "public" function API's should be relatively stable.

trevorld commented 6 years ago

Or perhaps somehow find a way to emphasize the user-facing "exported" functions (i.e. the real package API) and de-emphasize the "internal" functions (for developer use only).

Larger/small fonts, Bold, Explicit "exported"/"internal" labels or an explicit warning not to directly use "internal" functions?