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

PEP fix styling around docstring #1376

Closed
priyanshuone6 opened this issue Feb 11, 2021 · 2 comments · Fixed by #1383
Closed

PEP fix styling around docstring #1376

priyanshuone6 opened this issue Feb 11, 2021 · 2 comments · Fixed by #1383
Assignees

Comments

@priyanshuone6
Copy link
Member

I found these styling errors around docstring in functions in various files that doesn't adhere to Python's PEP guidelines.

def _reset(self):
"Reset citations to default only (only for testing purposes)"

def set_smoothing_parameters(self, k):
"Helper function to set all smoothing parameters"

PyBaMM/pybamm/util.py

Lines 63 to 64 in 9883106

def get_best_matches(self, key):
"Get best matches from keys"

Expected behavior
Find all those functions and replace " with 3 double quotes """ for consistency across the repository .

It can be marked as a good first issue

@asinghgaba
Copy link
Contributor

If anyone’s not working on it, I can get this done.

@valentinsulzer
Copy link
Member

There are probably several other places where it's like this, I wasn't aware of the PEP guideline for this

valentinsulzer added a commit that referenced this issue Feb 12, 2021
#1376 Fixed PEP styling around docstrings
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 a pull request may close this issue.

3 participants