python-docs-samples icon indicating copy to clipboard operation
python-docs-samples copied to clipboard

Top level docs are mis-placed or missing in most files

Open unforced opened this issue 4 years ago • 4 comments

Per go/code-snippets-style#descriptive-top-level-comment, we should have top level comments that are placed outside of the region tags, to describe the snippets.

From a brief walk through some parts of the repo, I'm noticing most files don't have the top level comment at all, and I also a noticed a number of them, particularly in storage/transfer_service where they are wrongly placed inside the bounds of the region tag, causing them to render in the c.g.c docs, which doesn't seem is the desirable functionality.

unforced avatar Sep 30 '21 17:09 unforced

Only 1331 region tags to check 🤩

dandhlee avatar Feb 19 '22 20:02 dandhlee

Filed b/221461626. We can use the fixit week to poke at the snippet files that don't conform to the style, but until then it won't be an easy task to try and get this in line. It is also going to be hard to enforce this for new snippets, which the FR will help.

dandhlee avatar Feb 25 '22 19:02 dandhlee

We're investigating further with the style changes. I'll report back once the samples steering committee discusses this.

dandhlee avatar Jun 19 '22 07:06 dandhlee