Make setters private #69

Closed
wants to merge 2 commits into
from

Projects

None yet

5 participants

@adiroiban

Problem

pep257 complains that setters (and mabye deleters) have no docstring.

Here is an example

    @property
    def enabled(self):
        """
        See: `IEntityConfiguration`.
        """
        return self._proxy.getBoolean(self._section_name, 'enabled')

    @enabled.setter
    def enabled(self, value):
        return self._proxy.setBoolean(
            self._section_name, 'enabled', value)

Documentation tools should ignore setters and deletes docstring when creating api docs.
Also, setters and deleters are pretty standard and they will only have a boilerplate text which will not say anything new.

Changes

Updated the parser to keep a record for decorators.

In Method.is_private i check the list of decorators and if decorators start with same name then it is marked private.

I have removed unused / broken tests from test_pep257 as this is just hoarding of junk. http://blog.8thlight.com/uncle-bob/2014/04/03/Code-Hoarders.html

Added test for new code.

How to test

Check that changed make sense

py.test test_pep257.py -v

Let me know if you find this useful.

Thanks!

@adiroiban

Master is also failing and is not my fault :( : https://travis-ci.org/GreenSteam/pep257/builds/22006902

Please see command used for running my tests.

@adiroiban

I now see that pep8 is failing. I will udpate my code ... is ugly to work with a master branch which is not clean.

@Nurdok
Member
Nurdok commented Nov 18, 2014

@adiroiban the master branch is now clean. Can you pull and merge it with your code so I can see if your tests are failing or not?

@keleshev keleshev self-assigned this Nov 18, 2014
@adiroiban

Hi. I don't have time right now to continue working on this but feel free to fork the branch.

@glennmatthews glennmatthews added a commit to glennmatthews/pep257 that referenced this pull request Feb 18, 2015
@glennmatthews glennmatthews Update PyCQA/pydocstyle#69 to latest code bbe1c9a
@glennmatthews
Contributor

This can probably be closed now that #107 is merged.

@Nurdok Nurdok closed this Jul 9, 2015
@keleshev keleshev was unassigned by adiroiban Jan 29, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment