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

[documentation] inconsistent keyword argument for Key.from_path #397

Closed
ghost opened this issue Dec 1, 2014 · 5 comments
Closed

[documentation] inconsistent keyword argument for Key.from_path #397

ghost opened this issue Dec 1, 2014 · 5 comments
Labels
api: datastore Issues related to the Datastore API. 🚨 This issue needs some love. triage me I really want to be triaged.

Comments

@ghost
Copy link

ghost commented Dec 1, 2014

documentation uses "dataset_id" whereas in the source code it takes a Dataset object with keyword "dataset"

@dhermes
Copy link
Contributor

dhermes commented Dec 1, 2014

Thanks for reporting.

Can you point out what part of the documentation?

@ghost
Copy link
Author

ghost commented Dec 1, 2014

https://googlecloudplatform.github.io/gcloud-python/datastore-keys.html

On Sun Nov 30 2014 at 4:29:20 PM Danny Hermes [email protected]
wrote:

Thanks for reporting.

Can you point out what part of the documentation?


Reply to this email directly or view it on GitHub
#397 (comment)
.

@ghost
Copy link
Author

ghost commented Dec 1, 2014

My mistake, it appears to have been fixed since I first saw it (and
accidentally reported it on buganizer)

On Sun Nov 30 2014 at 4:40:16 PM Eli Bixby [email protected] wrote:

https://googlecloudplatform.github.io/gcloud-python/datastore-keys.html

On Sun Nov 30 2014 at 4:29:20 PM Danny Hermes [email protected]
wrote:

Thanks for reporting.

Can you point out what part of the documentation?


Reply to this email directly or view it on GitHub
#397 (comment)
.

@dhermes
Copy link
Contributor

dhermes commented Dec 1, 2014

So, to clarify, you're saying the params description is incorrect?

screen_shot_032

Anything else I'm missing? (We'll get this fixed ASAP.)

I think it may be useful to have an automated checker that params actually match the signature:
http://www.bytebucket.org/logilab/pylint/pull-request/143/new-extensions-directory-new-optional/diff
and have mentioned it before.

@ghost
Copy link
Author

ghost commented Dec 1, 2014

I was using the documentation which has disappeared (on cloud.google.com I think?), which had this mistake. Present documentation does not say anything about Key.from_path the class method. Which uses dataset rather than dataset_id. The constructor does use dataset_id as listed, and is obviously the preferred method of instantiation).

EDIT: since I can't seem to find the offending documentation anymore, probably fine to close this.
EDIT2: was definitely originating from version issues. Sorry for the noise.

@silvolu silvolu closed this as completed Dec 15, 2014
@jgeewax jgeewax added the api: datastore Issues related to the Datastore API. label Jan 30, 2015
@jgeewax jgeewax modified the milestone: Datastore Stable Jan 30, 2015
@yoshi-automation yoshi-automation added triage me I really want to be triaged. 🚨 This issue needs some love. labels Apr 6, 2020
parthea pushed a commit that referenced this issue Jun 4, 2023
Source-Link: googleapis/synthtool@e3a1277
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:452901c74a22f9b9a3bd02bce780b8e8805c97270d424684bff809ce5be8c2a2

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
parthea pushed a commit that referenced this issue Jun 4, 2023
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
parthea added a commit that referenced this issue Aug 15, 2023
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <[email protected]>
parthea pushed a commit that referenced this issue Sep 20, 2023
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
vchudnov-g pushed a commit that referenced this issue Sep 20, 2023
chore: relocate owl bot post processor
parthea added a commit that referenced this issue Sep 22, 2023
* chore: exclude requirements.txt file from renovate-bot

Source-Link: googleapis/synthtool@f58d313
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:7a40313731a7cb1454eef6b33d3446ebb121836738dc3ab3d2d3ded5268c35b6

* update constraints files

* fix(deps): require protobuf 3.20.2

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <[email protected]>
parthea added a commit that referenced this issue Sep 22, 2023
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <[email protected]>
parthea pushed a commit that referenced this issue Oct 21, 2023
Source-Link: googleapis/synthtool@7ff4aad
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:462782b0b492346b2d9099aaff52206dd30bc8e031ea97082e6facecc2373244
parthea pushed a commit that referenced this issue Oct 21, 2023
* chore: Update gapic-generator-python to v1.8.5

PiperOrigin-RevId: 511892190

Source-Link: googleapis/googleapis@a45d9c0

Source-Link: googleapis/googleapis-gen@1907294
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMTkwNzI5NGIxZDgzNjVlYTI0ZjhjNWYyZTA1OWE2NDEyNGM0ZWQzYiJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* 🦉 Updates from OwlBot post-processor

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>
parthea pushed a commit that referenced this issue Oct 21, 2023
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
parthea pushed a commit that referenced this issue Oct 21, 2023
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
parthea pushed a commit that referenced this issue Oct 21, 2023
* docs: Fix formatting of request arg in docstring

chore: Update gapic-generator-python to v1.9.1
PiperOrigin-RevId: 518604533

Source-Link: googleapis/googleapis@8a085ae

Source-Link: googleapis/googleapis-gen@b2ab4b0
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9

* 🦉 Updates from OwlBot post-processor

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: datastore Issues related to the Datastore API. 🚨 This issue needs some love. triage me I really want to be triaged.
Projects
None yet
Development

No branches or pull requests

4 participants