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

Change transform.py to numpydoc style #213

Merged

Conversation

KybernetikJo
Copy link
Contributor

@KybernetikJo KybernetikJo commented Aug 27, 2023

This PR refactors the Slycot/slycot/transform.py in order to be closer to the numpydoc style as discussed in #100.
Should be part of #204.

(finished 12 of 12 routines)

Routine name Finished Status description
tb01id
*3
tb10pd
*3
tb03ad
*3
tb04ad
*3
tb05ad
*3
tc01od
*3
tc04ad
*3
td04ad
*3
tf01md
*3
tf01rd
*3
tf01rd
*3
tf01rd
*3

Status description:

  1. numpydoc docstring sections, fixed
  2. parameters data types, fixed and 1 fixed
  3. optional and default values, fixed and 2 fixed

@bnavigator bnavigator added this to the 0.6.0 milestone Aug 27, 2023
@KybernetikJo KybernetikJo force-pushed the numpydoc_transform_py branch 2 times, most recently from 9b48c68 to 9cddda4 Compare September 2, 2023 18:31
@KybernetikJo KybernetikJo marked this pull request as ready for review September 2, 2023 19:24
slycot/transform.py Outdated Show resolved Hide resolved
@KybernetikJo
Copy link
Contributor Author

KybernetikJo commented Jan 5, 2024

This PR splits the tests/test_transform.py file into single files, one file for a subroutine/function.

There is a comment in test_transform.py:

#
# test_transform.py - generic tests for transform routines
# repagh <rene.vanpaassen@gmail.com, May 2020
  • How should we handle such comments if the file structure changes?
  • It is an info not a copyright, right?
  • Should we copy such comments into every new file?

@bnavigator
Copy link
Collaborator

Technically it is a copyright, but the license is missing. Please copy it over, but as said in #206, don't go overboard with the file count.

@bnavigator bnavigator merged commit ef404e6 into python-control:master Jan 8, 2024
81 checks passed
@KybernetikJo KybernetikJo deleted the numpydoc_transform_py branch June 18, 2024 07:49
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.

2 participants