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.

Sign up for GitHub

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

Jump to bottom

Codacy style #75

Merged
merged 14 commits into from
Apr 26, 2021
Merged

Codacy style #75

merged 14 commits into from
Apr 26, 2021

Conversation

aburrell
Copy link
Owner

Description

Improve code style and safety, fixes #60

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

Ran unit tests locally

Test Configuration:

  • Operating system: OS X Mojave
  • Python version number: 3.7
  • Compiler with version number: gcc version 9.3.0 (MacPorts gcc9 9.3.0_5)
  • Any details about your local setup that are relevant: branched from develop

Checklist:

  • Make sure you are merging into the develop (not main) branch
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • Add a note to Changelog.rst, summarising the changes
  • Add yourself to AUTHORS.rst and .zenodo.json

@aburrell
DOC: updated markdown style
fd1f0d6 
Updated the markdown style using some codacy suggestions.
@aburrell
STY: improved PEP8
61b040b 
Improved PEP8 compliance, added comments, and safely incorporated special-instance code blocks that had been commented out.
@aburrell
DOC: updated docstring
3ed162a 
Updated a docstring to include clearer descriptions of the returned output.  Also improved PEP8 compliance and added inline comments.
@aburrell
STY: fixed dangerous kwarg input
cc58213 
Empty dicts and lists have the potential to point to the last input, so used NoneType instead.
@aburrell
DOC: updated changelog
0b75d77 
Updated the changelog with a summary of recent changes.
@aburrell aburrell linked an issue Apr 21, 2021 that may be closed by this pull request
STY: Codacy suggestions #60
Closed
@coveralls
Copy link

coveralls commented Apr 21, 2021 •
edited
Loading

Pull Request Test Coverage Report for Build 779

  • 4 of 4 (100.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 98.95%
Totals Coverage Status
Change from base Build 763: 0.0%
Covered Lines: 373
Relevant Lines: 377
💛 - Coveralls

@aburrell
STY: updated markdown headers
0129211 
Updated the markdown header style to use subheaders.
@aburrell
STY: updated list spacing
269f9a1 
Updated the list spacing.
@aburrell
STY: added shell flag
fc2b3b8 
Added a shell flag to the subprocess calls.
@aburrell
STY: updated markdown style
8e958cb 
Updated the list and header style.
@aburrell
STY: removed shell flag
4a4a69f 
Upon further reading, it is better to leave out the shell flag for these particular calls.
@aburrell
MAINT: added missing commas
926f19b 
Added missing commas after 'e.g.'.
@aburrell
STY: updated markdown style
8ce8696 
Another attempt to placate codacy.
@aburrell
STY: more markdown updates
aa24f35 
More updates to the markdown.
@aburrell
STY: last markdown tweak
8392af2 
Really, I am done with this.
@aburrell
Copy link
Owner Author

Also evaluated several code patterns to ignore in codacy.

@aburrell aburrell added this to the 1.1.1 Release milestone Apr 21, 2021
@aburrell aburrell marked this pull request as ready for review April 22, 2021 12:32
@aburrell aburrell merged commit 00c12cc into develop Apr 26, 2021
@aburrell aburrell deleted the codacy_style branch April 26, 2021 12:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
2.0.0 Release
Development

Successfully merging this pull request may close these issues.

STY: Codacy suggestions
2 participants
@aburrell @coveralls