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

irc: fix some typos & formatting in docstrings #2251

Merged
merged 1 commit into from Feb 13, 2022
Merged

irc: fix some typos & formatting in docstrings #2251

merged 1 commit into from Feb 13, 2022

Conversation

dgw
Copy link
Member

@dgw dgw commented Feb 9, 2022

Description

I noticed a couple of typos, but decided to give the whole file a good once-over to make a pull request worthwhile.

Checklist

  • I have read CONTRIBUTING.md
  • I can and do license this contribution under the EFLv2
  • No issues are reported by make qa (runs make quality and make test)
    • Doesn't touch code.
  • I have tested the functionality of the things this change touches
    • Ditto.

Notes

The intent is to backport all relevant fixes to 7.1.x, hence the milestone. I'm not sure if 100% of the patch will apply since some things have changed on master since the split, so there's a chance that the best approach will be a separate PR for the stable branch (in which case I'll reassign this one).

I noticed a couple of typos, but decided to give the whole file a good
once-over to make a pull request worthwhile.
@dgw dgw added this to the 7.1.8 milestone Feb 9, 2022
@dgw dgw requested a review from a team February 9, 2022 07:26
Copy link
Contributor

@Exirel Exirel left a comment

Choose a reason for hiding this comment

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

Every time there is a docstring to write or review, I wonder if we finally wrote a docstring guideline...

@dgw dgw merged commit 4322aa4 into master Feb 13, 2022
@dgw dgw deleted the irc-doc-qa-pass branch February 13, 2022 23:28
dgw added a commit that referenced this pull request Feb 13, 2022
irc: fix some typos & formatting in docstrings

Conflict occurred because of touching docs for methods/properties that
don't exist yet in 7.1.x, but I've made sure those didn't get backported
by mistake. API features shouldn't change in a maintenance release.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants