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 math.py to numpydoc style #211

Merged
merged 1 commit into from
Jan 7, 2024

Conversation

KybernetikJo
Copy link
Contributor

@KybernetikJo KybernetikJo commented Aug 27, 2023

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

(finished 7 of 7 routines)

Routine name Finished Status description
mb03rd
*3
mb03vd
*3
mb03vy
*3
mb03wd
*3
mb05md
*3
mb05nd
*3
mc01td
*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

@KybernetikJo
Copy link
Contributor Author

I have refactored the pytests of math.py. Now every wrapper has its own pytest file and a Test_class (even though there are not always multiple tests).

Now that I think about it, though, I'm not at all sure that organizing the tests in this way is the best approach. Anyway, I think I'll stick with it for now.


Questions:

Do we need the file "tests/CMakeLists.txt" ? Is it for conda?

set(PYSOURCE

  __init__.py
  test_ab01.py
  test_ab04md.py
  test_ab08n.py
  test_ag08bd.py
  test_examples.py
  test_exceptions.py
  test_mb.py
  test_mc.py
  test_sb.py
  test_analysis.py
  test_transform.py
  test_sg02ad.py
  test_sg03ad.py
  test_tb05ad.py
  test_td04ad.py
  test_tg01ad.py
  test_tg01fd.py )

install(FILES ${PYSOURCE}
        DESTINATION slycot/tests)

@bnavigator
Copy link
Collaborator

Please rebase (and optionally squash)

@KybernetikJo
Copy link
Contributor Author

@bnavigator I had some troubles with git, because a "git reset HEAD" I did at some point.

I think it should be OK, though.

@bnavigator
Copy link
Collaborator

Thanks @KybernetikJo!

For the record, contrary to the initial description of this PR, the test files have not been reorganized, following a discussion in #206.

@bnavigator bnavigator merged commit 58df98f into python-control:master Jan 7, 2024
26 checks passed
@KybernetikJo KybernetikJo deleted the numpydoc_math_py branch June 18, 2024 07:50
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