docs: fix upgrade guide #114
docs: fix upgrade guide #114
Conversation
0c18c1e
to
52ef355
Compare
52ef355
to
b0081d5
Compare
(2) with the (1) is the simplest, but some features cannot be used with it. |
UPGRADING.md
Outdated
## Common Resource Path Helper Methods | ||
|
||
| Applicable previous versions | | ||
|:-----------------------------| | ||
| v2.0.0 or lower | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is confusing to me. I believe 2.0 removed location_path
, but 3.0 added common_location_path
back.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You mean is:
"Users of v2.0.0 need not to migrate (ie: from their point of view, it's just new feature rather than breaking change)"
right?
So maybe better to write "v1.0.0 or lower"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah. I've made a suggested edit to clarify.
UPGRADING.md
Outdated
## Common Resource Path Helper Methods | ||
|
||
| Applicable previous versions | | ||
|:-----------------------------| | ||
| v2.0.0 or lower | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah. I've made a suggested edit to clarify.
Approved. Thank you @tmshn for the contribution! |
Merge-on-green attempted to merge your PR for 6 hours, but it was not mergeable because either one of your required status checks failed, one of your required reviews was not approved, or there is a do not merge label. Learn more about your required status checks here: https://help.github.com/en/github/administering-a-repository/enabling-required-status-checks. You can remove and reapply the label to re-run the bot. |
idk why CI doesnt run... |
π€ I have created a release \*beep\* \*boop\* --- ## [3.1.0](https://www.github.com/googleapis/python-datacatalog/compare/v3.0.0...v3.1.0) (2021-03-22) ### Features * add `client_cert_source_for_mtls` argument to transports ([#107](https://www.github.com/googleapis/python-datacatalog/issues/107)) ([59a44bc](https://www.github.com/googleapis/python-datacatalog/commit/59a44bc744a6322a2a23313c851eb77204110e79)) ### Bug Fixes * remove gRPC send/recv limit; add enums to `types/__init__.py` ([#87](https://www.github.com/googleapis/python-datacatalog/issues/87)) ([e0c40c7](https://www.github.com/googleapis/python-datacatalog/commit/e0c40c765242868570532b5074fd239aa2c259e9)) ### Documentation * document enum values with `undoc-members` option ([#93](https://www.github.com/googleapis/python-datacatalog/issues/93)) ([2dbb3ef](https://www.github.com/googleapis/python-datacatalog/commit/2dbb3ef062b52925ad421c5c469ed6e67671e878)) * fix `type_` attribute name in the migration guide ([#113](https://www.github.com/googleapis/python-datacatalog/issues/113)) ([2f98f22](https://www.github.com/googleapis/python-datacatalog/commit/2f98f2244271d92f79fdb26103478166958b8c8a)) * fix upgrade guide ([#114](https://www.github.com/googleapis/python-datacatalog/issues/114)) ([4bfa587](https://www.github.com/googleapis/python-datacatalog/commit/4bfa587903105cb3de2272618374df0b04156017)) * update the upgrade guide to be from 1.0 to 3.0 ([#77](https://www.github.com/googleapis/python-datacatalog/issues/77)) ([eed034a](https://www.github.com/googleapis/python-datacatalog/commit/eed034a3969913e40554300ae97c5e00e4fcc79a)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
* docs: reverts the table addition from #114 Removed formatted tables (reverts #114) Converted file back to .MD (reverts part of #268) * docs: revert changes to link * π¦ Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * docs: putting back this section Owlbot removed this but we need to keep it. * docs: fix whitespace issue * π¦ Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * rename docs/UPGRADING.rst to docs/UPGRADING.md * π¦ Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <partheniou@google.com>
Current upgrade guide is confusing especially when upgrading from v2.0.0 to v3.0.0 because some of the change is only introduced at v2.0.0. I fixed this.
This is just a documentation fix rather than code fix, so note that following checks are not passed
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:
Fixes #<issue_number_goes_here> π¦
Additional question
There are three way to invoke API-calling methods: (1) pass keyword arguments, (2) pass
request
argument with request class and (3) passrequest
argument with dict.The auto-migration tool
fixup_datacatalog_v1_keywords.py
fixes code to use method (3) even if the methods accepts keyword arguments. However, IMO, it's poorly typed and not linter/autocompletion-friendly.Actually what is the recommended way? And is there a plan to remove support of method (1)?
(1)
(2)
(3)