#19447: Intword and intabr expansion and intword_internal api exposure
----------------------------------+------------------------------------
Reporter: eire1130 | Owner: eire1130
Type: New feature | Status: new
Component: contrib.humanize | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
----------------------------------+------------------------------------
Comment (by lukeplant):
Our policy for all APIs is that they must be documented, or they are
considered internal implementation details - it's all or nothing. At the
moment, your 'Converter' class lies half-way - its existence is
documented, but not its methods. "Just inherit from Converter" is not a
documented API.
On the other hand, documenting it seems like overkill - none of the other
filters have ways of generating similar filters.
The bar for inclusion in Django is high - it needs to fulfil a common
need, and generating your own filters for displaying numbers does not seem
to be that common. If we are not going to fully document the API for
creating your own filters, then there is no point having that layer of
complication.
To me, at the moment, it seems that this would work just as well as an
external library, where you are free to design and document it as you
want.
--
Ticket URL: <https://code.djangoproject.com/ticket/19447#comment:5>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit https://groups.google.com/groups/opt_out.
