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

Document that we expect axis count to be an int #925

Merged
merged 2 commits into from
Jan 31, 2020
Merged

Document that we expect axis count to be an int #925

merged 2 commits into from
Jan 31, 2020

Conversation

bonjourmauko
Copy link
Member

Part of #924

Documentation

  • Annotates the expected type of the axis count in SimulationBuilder.

@bonjourmauko bonjourmauko added the kind:docs Add or improvement of documentation label Jan 3, 2020
@bonjourmauko bonjourmauko changed the title Ensure 'num' argument of 'numpy.linspace' is 'int' Document that we expect axis count to be an int Jan 3, 2020
@bonjourmauko
Copy link
Member Author

bonjourmauko commented Jan 3, 2020 •
edited
Loading

Hey @benjello, I'm moving discussion on #924 (comment) here.

I think we should just :

  • Make sure code is properly tested (we're using those methods as we should)
  • Make sure code is properly documented (type annotations, docstrings)

In this particular case, type annotating the variable is enough.

cc @Morendil

@bonjourmauko bonjourmauko force-pushed the compatibility-numpy-1.18 branch from 7f37987 to 78304c1 Compare January 3, 2020 09:38
@bonjourmauko bonjourmauko force-pushed the compatibility-numpy-1.18 branch from 78304c1 to a37f41d Compare January 31, 2020 10:49
@bonjourmauko bonjourmauko merged commit 9144bb0 into master Jan 31, 2020
@bonjourmauko bonjourmauko deleted the compatibility-numpy-1.18 branch January 31, 2020 10:52
@Morendil Morendil mentioned this pull request Feb 7, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benjello benjello benjello approved these changes

Assignees
No one assigned
Labels
kind:docs Add or improvement of documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@bonjourmauko @benjello