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

In line code comment documentation #142

Merged
merged 2 commits into from
Dec 16, 2023
Merged

In line code comment documentation #142

merged 2 commits into from
Dec 16, 2023

Conversation

giovasdistillery
Copy link
Contributor

Expectations

  • Creation of the documentation for the know code
  • The documentation of the code must work for Android Studio IDE

Notes

  • All the documentation added is for the known code and taking the documentation for Flutter SDK project as Base to see what is the functionality for some methods

Important

  • A lot of code is not documented yet because I'm not sure enough of the functionality for it

@giovasdistillery
In line code comment documentation
ad742e1 
Creation of the documentation for the know code
@giovasdistillery giovasdistillery added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 5, 2023
@giovasdistillery giovasdistillery requested a review from a team as a code owner December 5, 2023 03:11
@nplasterer
Copy link
Contributor

@fabriguespe do you mind reviewing these inline code comments for accuracy?

@nplasterer nplasterer requested a review from humanagent December 5, 2023 20:07
nplasterer
nplasterer approved these changes Dec 16, 2023
View reviewed changes
Copy link
Contributor

@nplasterer nplasterer left a comment

Choose a reason for hiding this comment

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

I skimmed most of these comments. But looks good to me.

@nplasterer nplasterer enabled auto-merge (squash) December 16, 2023 05:39
@nplasterer nplasterer merged commit 1eb7b1f into main Dec 16, 2023
5 of 6 checks passed
@nplasterer nplasterer deleted the gg/enhancement/inline_code_documentation branch December 16, 2023 05:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nplasterer nplasterer nplasterer approved these changes

@humanagent humanagent Awaiting requested review from humanagent

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@giovasdistillery @nplasterer