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

Fix inductor units in media docstrings #835

Merged
merged 1 commit into from
Feb 8, 2023
Merged

Conversation

ericwrice
Copy link
Contributor

No description provided.

@github-actions github-actions bot added the Media label Feb 6, 2023
@Vinc0110
Copy link
Collaborator

Vinc0110 commented Feb 7, 2023

Good catch, inductance should not be in Farad.
Personally, I would prefer the singular form for the unit, i.e. "Henry".

@ericwrice
Copy link
Contributor Author

I can certainly change it to singular if that is preferred, I went with plural to be consistent with the resistor and capacitor doc strings.

@Vinc0110
Copy link
Collaborator

Vinc0110 commented Feb 7, 2023

It's probably not that important. Keeping it consistent is also a good thing.

Just for future reference, there exists a NIST guide with rules for spelling SI units:
https://www.nist.gov/pml/special-publication-811/nist-guide-si-chapter-9-rules-and-style-conventions-spelling-unit-names

Following those rules would certainly require a major revision on many docstrings...

Copy link
Member

@jhillairet jhillairet left a comment

Choose a reason for hiding this comment

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

Good catch, thank you !

@jhillairet jhillairet added the Documentation Request/Improvement of the documentation label Feb 7, 2023
@Vinc0110 Vinc0110 merged commit ea17d21 into scikit-rf:master Feb 8, 2023
@jhillairet jhillairet mentioned this pull request Feb 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Request/Improvement of the documentation Media
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants