Skip to content
This repository has been archived by the owner on Nov 29, 2023. It is now read-only.

fix(doc): Remove new line in documentation comment #267

Merged
merged 3 commits into from
Jan 14, 2022

Conversation

adamread
Copy link
Contributor

The newline in the comment caused a space in the generated documentation, breaking the link. Removing the newline should fix the link in the generated doc (see line 146 for an example of this already in the file).

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

Fixes #266

The newline in the comment caused a space in the generated documentation, breaking the link. Removing the newline should fix the link in the generated doc (see line 146 for an example of this already in the file).
@adamread adamread requested a review from a team January 12, 2022 16:33
@adamread adamread requested a review from a team as a code owner January 12, 2022 16:33
@adamread adamread requested a review from tswast January 12, 2022 16:33
@product-auto-label product-auto-label bot added the api: bigquerydatatransfer Issues related to the googleapis/python-bigquery-datatransfer API. label Jan 12, 2022
@adamread adamread changed the title Remove new line in documentation comment fix(doc): Remove new line in documentation comment Jan 12, 2022
@tswast
Copy link
Contributor

tswast commented Jan 13, 2022

Thanks for the contribution! Unfortunately, since this is generated code our bot friend owlbot will immediately revert this change.

I looked at the source proto https://github.com/googleapis/googleapis/blob/e7aa1494257e326beb6798104fc6373d4c4fc4b8/google/cloud/bigquery/datatransfer/v1/transfer.proto#L137 which appears to be correct.

The problem must be with the generator. I've filed googleapis/gapic-generator-python#1131

@tswast tswast added the owlbot:run Add this label to trigger the Owlbot post processor. label Jan 13, 2022
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jan 13, 2022
@tswast
Copy link
Contributor

tswast commented Jan 13, 2022

Well, I triggered owlbot and it didn't revert the change as far as I can tell. Perhaps the generator is smart enough not to overwrite this?

@tswast tswast added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 13, 2022
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 13, 2022
@tswast tswast added the owlbot:run Add this label to trigger the Owlbot post processor. label Jan 13, 2022
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jan 13, 2022
@tswast tswast added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 13, 2022
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 13, 2022
@tswast tswast added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 13, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
api: bigquerydatatransfer Issues related to the googleapis/python-bigquery-datatransfer API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Link broken in generated documentation.
4 participants