DOC: Add composition example to internals.rst #9984
Conversation
| Define Original Data Structures using pandas | ||
| -------------------------------------------- | ||
|
|
||
| .. warning:: If you simply want to add some functionalities to ``pandas``, the easiest |
There was a problem hiding this comment.
should be "functionality" not "functionalities (here and next paragraph)
sinhrks
force-pushed
the
doc_composition
branch
from
0ee0d62 to
3cf2c13
Compare
|
|
||
| This section describes how to define your original data structure which extends ``pandas`` functionality using `composition <http://en.wikipedia.org/wiki/Composition_over_inheritance>`_. | ||
|
|
||
| Below example shows an original class which is mostly compatible with ``Series``. |
There was a problem hiding this comment.
Below example -> The example below
|
I made a few grammar/language suggestions. But actually, I'm not sure this example makes the best case for why composition is usually a better idea than subclassing. Using So many we should show an example of how subclassing can lead to unexpected behavior or a more realistic version of composition that simply makes use of a series or frame to hold internal state. |
|
status? |
|
@sinhrks going to move this to next version. |
|
@sinhrks can you update |
|
closing, but if you'd like to update, pls reopen |
Follow-up of #9802. Added an example of composition to internal.rst.
Also, fixed broken section name for subclass document.