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

Conform function headers to coding guidelines #5255

Merged
merged 3 commits into from
Jun 8, 2017
Merged

Conversation

Phyma
Copy link
Contributor

@Phyma Phyma commented Jun 6, 2017

When merged this pull request will:

  • Fix every header on all files that i have on my fork
  • Tested with Silentspikes python script Add public function documentation script #5253
  • Even if the other thing is not accepted this is still good
  • Alot of things that i have done is switch to current header, add example, add public and fixed "ReturnValue" to "Return Value"

I believe this is a label "impact/trivial" because it's only headers

@kymckay kymckay added area/documentation ignore-changelog Release Notes: Excluded kind/cleanup Release Notes: **CHANGED:** labels Jun 6, 2017
@kymckay kymckay changed the title Fixed headers to work with silentspike python script Conform function headers to coding guidelines Jun 6, 2017
*
*
* Arguments:
* Nothing
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be None, I noticed it was wrong in some other files before as well.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The script will now complain about this too after latest commit 😄

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeay. Well we can put this as WIP so I can fix this in the same tempo that silentspike updates the script and we just do both at the same time :)

I was just bored and didnt feel like scripting so did this.

@Phyma
Copy link
Contributor Author

Phyma commented Jun 8, 2017

Done! No more errors! Plus new version of the software only public functions

Copy link
Member

@jonpas jonpas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I say merge this ASAP to prevent merge conflicts. If there are other things to fix in headers, they can be done separately from this.

@jonpas jonpas added this to the 3.10.0 milestone Jun 8, 2017
@bux
Copy link
Member

bux commented Jun 8, 2017

DO IT NAOW!

@jonpas jonpas merged commit ffaa195 into acemod:master Jun 8, 2017
@jonpas jonpas added kind/documentation and removed ignore-changelog Release Notes: Excluded labels Jun 8, 2017
@Phyma Phyma deleted the fixHeaders branch June 8, 2017 18:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/cleanup Release Notes: **CHANGED:** kind/documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants