Skip to content
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.

Make setters private #69

Closed
wants to merge 2 commits into from
Closed

Make setters private #69

wants to merge 2 commits into from

Conversation

adiroiban
Copy link

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!

@sigmavirus24
Copy link
Member

Your tests are failing https://travis-ci.org/GreenSteam/pep257/builds/22946274

@adiroiban
Copy link
Author

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
Copy link
Author

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
Copy link
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
Copy link
Author

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

glennmatthews added a commit to glennmatthews/pep257 that referenced this pull request Feb 18, 2015
Nurdok added a commit that referenced this pull request Mar 25, 2015
Make setters private (rework of #69)
@glennmatthews
Copy link
Contributor

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants