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

feat(go): comments are enhanced to provide better developer experience #1536

Merged
merged 3 commits into from
May 16, 2023

Conversation

mehmetaligok
Copy link
Contributor

@mehmetaligok mehmetaligok commented May 11, 2023

🧭 What and Why

🎟 JIRA Ticket: https://algolia.atlassian.net/browse/APIC-665

To improve the developer experience, we need better documentation on our code so the users will not need to switch between external documentation and code again and again.

Changes included:

  • Added and improved comments on all the requests.
  • Some pieces are reordered to give easier navigation when using the package.

🧪 Test

Nothing changed functionally, generated commit can be checked to see examples of the comments.

@mehmetaligok mehmetaligok self-assigned this May 11, 2023
@netlify
Copy link

netlify bot commented May 11, 2023

Deploy Preview for api-clients-automation ready!

Name Link
🔨 Latest commit 5ab290d
🔍 Latest deploy log https://app.netlify.com/sites/api-clients-automation/deploys/64638d497f9cfe0008b25ca2
😎 Deploy Preview https://deploy-preview-1536--api-clients-automation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@algolia-bot
Copy link
Collaborator

algolia-bot commented May 11, 2023

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the main branch.
You can still access the code generated on main via this commit.

@mehmetaligok mehmetaligok marked this pull request as ready for review May 11, 2023 14:22
@mehmetaligok mehmetaligok requested a review from a team as a code owner May 11, 2023 14:22
@mehmetaligok mehmetaligok requested review from aallam and shortcuts May 11, 2023 14:22
Copy link
Contributor

@Fluf22 Fluf22 left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Member

@shortcuts shortcuts left a comment

Choose a reason for hiding this comment

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

Huge improvements, gg!

@mehmetaligok mehmetaligok merged commit 72755c1 into main May 16, 2023
@mehmetaligok mehmetaligok deleted the feat/go-client-enhance-comments branch May 16, 2023 14:14
algolia-bot added a commit to algolia/algoliasearch-client-javascript that referenced this pull request May 16, 2023
algolia/api-clients-automation#1536

Co-authored-by: Mehmet Ali Gok <33124154+mehmetaligok@users.noreply.github.com>
algolia-bot added a commit to algolia/algoliasearch-client-java that referenced this pull request May 16, 2023
algolia/api-clients-automation#1536

Co-authored-by: Mehmet Ali Gok <33124154+mehmetaligok@users.noreply.github.com>
algolia-bot added a commit to algolia/algoliasearch-client-php that referenced this pull request May 16, 2023
algolia/api-clients-automation#1536

Co-authored-by: Mehmet Ali Gok <33124154+mehmetaligok@users.noreply.github.com>
algolia-bot added a commit to algolia/algoliasearch-client-go that referenced this pull request May 16, 2023
algolia/api-clients-automation#1536

Co-authored-by: Mehmet Ali Gok <33124154+mehmetaligok@users.noreply.github.com>
algolia-bot added a commit to algolia/algoliasearch-client-kotlin that referenced this pull request May 16, 2023
algolia/api-clients-automation#1536

Co-authored-by: Mehmet Ali Gok <33124154+mehmetaligok@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants