Skip to content

chore: references to "googleapis" master branch #271

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.

Sign up for GitHub

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

Jump to bottom
Open
3 tasks
nicain opened this issue Sep 2, 2021 · 2 comments
Open
3 tasks

chore: references to "googleapis" master branch #271

nicain opened this issue Sep 2, 2021 · 2 comments
Labels
type: docs Improvement to the documentation for an API.

Comments

@nicain
Copy link
Contributor

nicain commented Sep 2, 2021

During the master --> main migration, I noticed references that point to the master branch of https://github.com/googleapis/googleapis

After that repo is migrated, we will need to circle back to this repo (and potentially others) and fix these references

  • google/api_core/exceptions.py
  • google/api_core/operations_v1/operations_async_client.py
  • google/api_core/operations_v1/operations_client.py

xref: googleapis/google-cloud-python#10579
@busunkim96 busunkim96 added the type: docs Improvement to the documentation for an API. label Sep 3, 2021
@busunkim96 busunkim96 self-assigned this Sep 3, 2021
@vchudnov-g
Copy link
Contributor

Of the three files listed, it seems only the first one refers to main in comment strings. Should be an easy fix...once we migrate master to main in googleapis/googleapis, which we still haven't done.

Alternatives:

  • just link to the SHA rather than to the branch name. This is probably more robust, particularly for those references that link with a line number. That is very likely to change if we don't link to a particular commit
    OR
  • remove the links altogether if they don't add value

@vchudnov-g
Copy link
Contributor

Update: We will assess completing this task in relation to our other priorities.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type: docs Improvement to the documentation for an API.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@nicain @vchudnov-g @busunkim96