googleapis / googleapis/librarian

java: format spanner samples after spanner team confirms this doesn't impact public docs

Open
#6,095 0 comments 0 reactions 0 assignees View on GitHub
priority: p3
Dominant language
Go
Stars
45
Forks
61
Avg merge
19h 11m
Merged PRs (30d)
181

Description

@rahul2393 I am not saying that we shouldn't do this. My concern is that we have done it in this way probably because we had concerns with the formatting in the past. We should clarify with the docs team before we do this change is what I am suggesting. (Since samples was explicitly removed in https://github.com/googleapis/synthtool/pull/1295 maybe because formatting is reducing the snippet clarity or some other reason).

_Originally posted by @sakthivelmanii in https://github.com/googleapis/google-cloud-java/issues/13228#issuecomment-4490936514_

Contributor guide

Open the contributing guide

Research direction

Review googleapis/google-cloud-java issue #13228 and googleapis/synthtool PR #1295 to understand why sample formatting was removed. Confirm with the docs team whether formatting affects snippet clarity; done means the concern is resolved and the scope of any safe change is clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.