Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert docstrings to reStructuredText #211

Merged
merged 1 commit into from
Jan 12, 2018
Merged

Convert docstrings to reStructuredText #211

merged 1 commit into from
Jan 12, 2018

Conversation

JoeLametta
Copy link
Collaborator

@JoeLametta JoeLametta commented Jan 6, 2018

WIP and untested. For more information please see #9, #73.
Unrelated changes included in this branch (made after a new PEP8 cleanup stage):

  • Whitespace / code formatting
  • Syntax related: except <exception_name>, e -> except <exception_name> as e
  • Pointless instructions (see the following block). Spotted by semi-automatic conversion (only 3 instances)
# OLD
var = self.var.keys() = sorted(self.var.keys())
var.sort()

# NEW
var = sorted(self.var.keys()) 

The unrelated changes shouldn't have any real impact on whipper's behaviour.

This commit also includes:

  - whitespace / code formatting fixes
  - slight syntax related changes: except <exception_name>, e -> except <exception_name> as e
  - 3 pointless instructions instances have been rewritten [sorted] (spotted by semi-automatic check)

The unrelated changes shouldn't have any real impact on whipper's behaviour.
@JoeLametta JoeLametta changed the title Convert docstrings to reST Convert docstrings to reStructuredText Jan 12, 2018
@JoeLametta JoeLametta merged commit cac64f0 into master Jan 12, 2018
@JoeLametta JoeLametta deleted the reST branch January 12, 2018 10:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant