Skip to content

adding parameter documentation explanation when it could have two differents types #4767

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
Merged
merged 1 commit into from
May 18, 2021
Merged

adding parameter documentation explanation when it could have two differents types #4767

merged 1 commit into from
May 18, 2021

Conversation

jposada202020
Copy link

@jposada202020 jposada202020 commented May 15, 2021 •
edited
Loading

When documenting class parameters. In some cases the documented parameter could have two different types.
This include reference in the design guide in how to achieve this.

For reference see these two pull requests:

@jposada202020 jposada202020 requested a review from kattni May 15, 2021 16:12
tannewt
tannewt approved these changes May 18, 2021
View reviewed changes
Copy link
Member

@tannewt tannewt left a comment

Choose a reason for hiding this comment

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

Thank you!

@tannewt tannewt merged commit c2ebe55 into adafruit:main May 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tannewt tannewt tannewt approved these changes

@kattni kattni Awaiting requested review from kattni

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

Successfully merging this pull request may close these issues.
2 participants
@jposada202020 @tannewt