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

Formatting API documents #912

Merged
merged 4 commits into from
May 22, 2023
Merged

Formatting API documents #912

merged 4 commits into from
May 22, 2023

Conversation

keikawa
Copy link
Contributor

@keikawa keikawa commented May 20, 2023

I have corrected the formatting of the Network and Plotting API documentation.
The format mimics the Numpy API documentation as follows

  • Capitalize the beginning of a sentence
  • Add a period at the end of a sentence
  • When starting a verb, do not add an s in the third person singular.

jhillairet
jhillairet approved these changes May 21, 2023
View reviewed changes
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.

Thanks!

@jhillairet jhillairet merged commit 4d413c2 into scikit-rf:master May 22, 2023
11 checks passed
@jhillairet jhillairet mentioned this pull request Jun 26, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jhillairet jhillairet jhillairet approved these changes

Assignees
No one assigned
Labels
Network Plotting
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@keikawa @jhillairet