-
Notifications
You must be signed in to change notification settings - Fork 168
Description
Hi @HemangChothani could you take a look at this customer feedback?
~~ Copied below ~~
DESCRIPTION:
[Summarize the bug or feature request.]
There's some confusion in our public documentation for Cloud Storage concerning list_blobs call. Specifically,
https://googleapis.dev/python/storage/latest/client.html - there's functions at the Storage level that match those in Bucket (https://googleapis.dev/python/storage/latest/buckets.html). For example, list_blobs. I'm aware it says it's deprecated for list_blobs on Buckets documentation. Is there any plans to remove it completely? Not sure about best practices for documentation, just curious as we had a customer who was led astray by this during their development.
In a similar vein, "user_project (str) – (Optional) This parameter is currently ignored.". Could this be clarified on why it is ignored, maybe with a small comment? It's also a source of confusion for our general users without reading through.
Just checking to see if documentation can be updated/if it's written as intended to get some clarity around documentation practices, thanks!
BUG-SPECIFIC FIELDS:
[If a bug, then also fill in the fields below. If not, then delete this section.]
LINKS:
[Paste link/s for affected content.]
https://googleapis.dev/python/storage/latest/buckets.html
https://googleapis.dev/python/storage/latest/client.html
INACCURATE CONTENT:
[If this is a bug, then paste the incorrect content.]
SUGGESTED CONTENT:
[If this is a bug and you know the solution, then paste a rough draft of what the content should look like.]