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

Rewrite of finisher_api Godocs #5618

Merged
merged 1 commit into from Sep 9, 2022

Conversation

bruc3mackenzi3
Copy link
Contributor

@bruc3mackenzi3 bruc3mackenzi3 commented Aug 17, 2022

  • Do only one thing
  • Non breaking API changes
  • Tested

What did this pull request do?

This PR contains a general rewrite of the method Godocs in finisher_api.go, including:

  • Fix grammar & spelling, improve wording
  • Employ consistent language across all documentation
  • Explicitly reference method parameters in comments
  • Fill gaps in explanations
    • I've used existing documentation from gorm.io when available
    • when not available I've done my best to write my own description of what the method does
  • limit line length to 120 chars

User Case Description

This will improve usability of GORM by providing enhanced inline documentation

@bruc3mackenzi3
Copy link
Contributor Author

@jinzhu please give this PR a review when you get the chance.

Are you interested in receiving more contributions like this? If the GORM project is interested in improvements to documentation I would like to continue contributing.

@jinzhu jinzhu merged commit f29afdd into go-gorm:master Sep 9, 2022
@jinzhu
Copy link
Member

jinzhu commented Sep 9, 2022

Hello @bruc3mackenzi3

Yeah, which is really helpful, thank you for the awesome work.

If possible, you can also contribute to this repo github.com/go-gorm/gorm.io, which used to host website https://gorm.io

@bruc3mackenzi3
Copy link
Contributor Author

Thanks for your review & approval, Jinzhu. Is there anything I can do to have my PRs reviewed sooner? A faster turnaround on submitted PRs will help facilitate more contributions to the GORM project. I posted a Discussion about it here as well.

jinzhu pushed a commit that referenced this pull request Sep 22, 2022
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.

None yet

2 participants