Skip to content

docs: modify docstrings in event.py - #464

Merged
julien-duponchelle merged 1 commit into
julien-duponchelle:mainfrom
python-mysql-replication-kr:feature/modify-docstrings
Sep 1, 2023
Merged

julien-duponchelle merged 1 commit into
julien-duponchelle:mainfrom
python-mysql-replication-kr:feature/modify-docstrings

Conversation

@ebang091

@ebang091 ebang091 commented Aug 31, 2023 •

Copy link
Copy Markdown
Contributor

Change

  • Reviewed the existing docstrings to identify variables that need more detailed descriptions.
  • Updated the docstrings to include a concise yet comprehensive description for each identified variable.

Before Changing

스크린샷 2023-08-30 오후 11 38 19

After adding docstrings

Untitled (1)

I appreciate so much that this project provides nice docs using sphinx.
So, I hope this improvement can attribute to the quality of the docs. Thank you.

I re-requested this PR after squashing. Thank you.

related Issue: #462

Co-authored-by: ebang091 <[email protected]>
Co-authored-by: dongwook-chan <[email protected]>
Co-authored-by: starcat37 <[email protected]>
Co-authored-by: mjs1995 <[email protected]>
Co-authored-by: heehehe <[email protected]>
@julien-duponchelle

Copy link
Copy Markdown
Owner

Amazing !

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