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

Remove extraneous spaces from docstrings in modules 2 #1496

Merged
merged 1 commit into from
Nov 1, 2022

Conversation

Tortar
Copy link
Contributor

@Tortar Tortar commented Nov 1, 2022

Some of the modules were missed in #1493, sorry

@codecov
Copy link

codecov bot commented Nov 1, 2022

Codecov Report

Base: 91.46% // Head: 91.46% // No change to project coverage 👍

Coverage data is based on head (c46e83a) compared to base (be9c538).
Patch has no changes to coverable lines.

❗ Current head c46e83a differs from pull request most recent head 4054a3a. Consider uploading reports for the commit 4054a3a to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1496   +/-   ##
=======================================
  Coverage   91.46%   91.46%           
=======================================
  Files          15       15           
  Lines        1300     1300           
  Branches      223      223           
=======================================
  Hits         1189     1189           
  Misses         78       78           
  Partials       33       33           
Impacted Files Coverage Δ
...esa/visualization/modules/BarChartVisualization.py 88.88% <ø> (ø)
...a/visualization/modules/CanvasGridVisualization.py 95.83% <ø> (ø)
mesa/visualization/modules/ChartVisualization.py 91.66% <ø> (ø)
mesa/visualization/modules/HexGridVisualization.py 96.29% <ø> (ø)
mesa/visualization/modules/NetworkVisualization.py 100.00% <ø> (ø)
...esa/visualization/modules/PieChartVisualization.py 91.66% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@rht
Copy link
Contributor

rht commented Nov 1, 2022

Just to make sure, are those the remaining ones, and no more?

@Tortar
Copy link
Contributor Author

Tortar commented Nov 1, 2022

Actually need to check the other folders apart from the mesa one

@Tortar
Copy link
Contributor Author

Tortar commented Nov 1, 2022

ok, now it's done in all the folders

@rht
Copy link
Contributor

rht commented Nov 1, 2022

LGTM

@rht rht merged commit 8d052a1 into projectmesa:main Nov 1, 2022
@EwoutH
Copy link
Member

EwoutH commented Nov 1, 2022

It might be useful to adopt a style guide for docstrings. Common ones:

For example, the NumPy style guide maintains a white line before the last """, while the others do not.

@Tortar
Copy link
Contributor Author

Tortar commented Nov 1, 2022

I'm surely in favor of a style guide and I prefer one without the last blank line 👍

@jackiekazil
Copy link
Member

@EwoutH can you start that topic as a discussion so it doesn't get lost in this PR

@rht
Copy link
Contributor

rht commented Nov 2, 2022

I wonder if the white line convention can be enforced in a linter? I'm saying it here instead of in the discussion thread that @EwoutH is going to start, or else I might forget to say this.

@EwoutH
Copy link
Member

EwoutH commented Nov 2, 2022

@EwoutH can you start that topic as a discussion so it doesn't get lost in this PR

Good idea, here we go: #1499

@jackiekazil jackiekazil added this to the v1.2.0 Taylor milestone Feb 27, 2023
@jackiekazil jackiekazil mentioned this pull request Mar 7, 2023
4 tasks
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.

4 participants