Documentation shows private functions
See original GitHub issueThe documentation lists some functions that are not available outside the submodule they are defined in. All of the usage examples use:
import humanize
humanize.…
but this does not allow access to these methods.
These functions should be exported to the parent module.
Issue Analytics
- State:
- Created 2 years ago
- Comments:6 (3 by maintainers)
Top Results From Across the Web
Should I document my private methods? - Stack Overflow
Yes, it is necessary to document your private methods. It becomes increasingly necessary as more developers are using your code ...
Read more >Documenting private methods. - Google Groups
Private functions are meant to be implementation details. You can't even call them directly. Documentation are for folks that want to use your ......
Read more >Private Functions - MATLAB & Simulink - MathWorks
This topic explains the term private function, and shows how to create and use private functions. Private functions are useful when you want...
Read more >Is it necessary to warn about the @doc attribute for a private ...
Private functions do not have descriptions to display in programming tools when suggesting or looking up docs of a function, since they do...
Read more >Writing Documentation – Elixir v1.5.0 - HexDocs
Documenting Private Functions Elixir warns if a private function has a @doc attribute and discards its content, because @doc is intended to...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Thanks for the PR!
I wonder if we should instead deprecate these (emit
DeprecationWarning
s) and make them private in the next major release?(For example, rename
gettext
to_gettext
, call_gettext
internally, and have a newgettext
that emits the warning and calls_gettext
.)The functions in question:
i18n
:gettext
andngettext
.time
:abs_timedelta
,date_and_delta
,Unit
These are all pretty much intended for internal use, that’s probably why they weren’t made fully public.
Yes, this is what I had in mind, thank you!