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

docs(golang driver): add some comments for use with GoDoc #1504

Closed
wants to merge 1 commit into from

Conversation

mjholub
Copy link

@mjholub mjholub commented Jan 11, 2024

some formatting changes were made automatically with gofumpt

Copy link
Contributor

@jrgemignani jrgemignani left a comment

Choose a reason for hiding this comment

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

I'm not sure if this is necessary. Thoughts? Justifications?

@mjholub
Copy link
Author

mjholub commented Feb 7, 2024

hmm perhaps writing examples could be more beneficial, made that PR because the driver felt somewhat confusing to me at first. see other database libraries on godoc for comparison, like pgx or go-sqlite3

@mjholub
Copy link
Author

mjholub commented Feb 8, 2024

Though if it may cause any merge conflict with anything that changes the codebase, please just merge the code changes first and then I'd happily rebase and remove any outdated comments

@jrgemignani
Copy link
Contributor

@mjholub You should be able to rebase your PR's local branch with the AGE master and then do a force push to your remote mjholub:go-driver-documentation branch. That will cause the PR to be updated and should restart all of the PR checks.

@mjholub
Copy link
Author

mjholub commented Feb 21, 2024

@jrgemignani yeah I know, it appears there are no conflicts though

@jrgemignani
Copy link
Contributor

@mjholub Please fill out the optional extended description with a brief (few lines) description of your changes. You will likely need to do this locally and force push it to your remote branch to update this PR.

image

Copy link
Contributor

@jrgemignani jrgemignani left a comment

Choose a reason for hiding this comment

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

Request addition of extending commit description.

@jrgemignani
Copy link
Contributor

@mjholub Can you please make the update so that I can merge the PR :)

@mjholub
Copy link
Author

mjholub commented Mar 9, 2024

I'll take care of it soon

Copy link

This PR is stale because it has been open 45 days with no activity. Remove "Abondoned" label or comment or this will be closed in 7 days.

@github-actions github-actions bot added the Stale Stale issues/PRs label May 11, 2024
Copy link

This PR was closed because it has been stalled for further 7 days with no activity

@github-actions github-actions bot closed this May 19, 2024
@mjholub mjholub deleted the go-driver-documentation branch May 20, 2024 20:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
master Stale Stale issues/PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants