search

dadadel / pyment

Format and convert Python docstrings and generates patches
GNU General Public License v3.0
905 stars 62 forks source link

Let NumpydocTools and GoogledocTools inherit from a common base class #63

Closed wagnerpeer closed 6 years ago

wagnerpeer commented 6 years ago

As discussed in the abandoned (closed) PR #60, I open up another issue better suited to the changes I propose. During modifications to the source code to fix issue #49, I realized that there was room for improvement in how the different docstring styles (Numpydoc and Googledoc) were handled. They had a lot of duplicate code and if they would have used a common base class, issue #49 should not have happened, as the GoogledocTools class already contained the solution.

My proposal is to introduce the common base class to prevent future issues arising because of duplicate logic in the now different "DocTools"

wagnerpeer commented 6 years ago

As PR #64 is merged, this issue can be closed.