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: move example inline into godoc #4626

Merged
merged 6 commits into from Aug 16, 2021
Merged

docs: move example inline into godoc #4626

merged 6 commits into from Aug 16, 2021

Conversation

codyoss
Copy link
Member

@codyoss codyoss commented Aug 16, 2021

This change is needed, at least temporarily, to facilitate the
splitting of modules. The parent module can't depend on a module
that is about to be split out as tidying will fail to resolve
import paths as the code no longer exists.

This change is needed, at least temporarily, to facilitate the
splitting of modules. The parent module can't depend on a module
that is about to be split out as tidying will fail to resolve
import paths as the code no longer exists.
@codyoss codyoss requested a review from a team as a code owner August 16, 2021 20:20
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Aug 16, 2021
@codyoss codyoss requested review from noahdietz and tbpg August 16, 2021 20:20
Copy link
Contributor

@tbpg tbpg left a comment

Choose a reason for hiding this comment

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

We can't do a 2-step process to avoid this? Publish the new module then update the root module?

doc.go Outdated Show resolved Hide resolved
Co-authored-by: Tyler Bui-Palsulich <26876514+tbpg@users.noreply.github.com>
@codyoss
Copy link
Member Author

codyoss commented Aug 16, 2021

@tbpg I don't think so. Root module needs to be tagged first so that the sub-module can depend on it. Once tagged it can no longer reference the new child mods code without a new dependency on the child mod. I think we should avoid having the root depend on any gapic packages if possible.

Copy link
Contributor

@tbpg tbpg left a comment

Choose a reason for hiding this comment

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

Ah, got it. Thanks for the explanation.

@codyoss codyoss added the automerge Merge the pull request once unit tests and other checks pass. label Aug 16, 2021
@gcf-merge-on-green gcf-merge-on-green bot merged commit 0b539fe into googleapis:master Aug 16, 2021
@gcf-merge-on-green gcf-merge-on-green bot removed the automerge Merge the pull request once unit tests and other checks pass. label Aug 16, 2021
@codyoss codyoss deleted the redo-examples branch September 11, 2021 19:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants