docs: fix api-ref method-heading naming typos and duplicate section - #1857
Open
jacalata wants to merge 2 commits into
Open
docs: fix api-ref method-heading naming typos and duplicate section#1857jacalata wants to merge 2 commits into
jacalata wants to merge 2 commits into
Conversation
api-ref.md addressed several endpoint methods with the singular form of the endpoint attribute rather than the plural form actually bound on `Server`: - `datasource.*` -> `datasources.*` (2 headings) - `subscription.*` -> `subscriptions.*` (4 headings) - `webhook.*` -> `webhooks.*` (5 headings) - `groupsets.*` -> `group_sets.*` (9 headings) Discovered while auditing api-ref.md against source for the Sphinx migration in server-client-python#1832. Section content is unchanged; only heading + code-block invocation lines are renamed. No internal anchor links reference the old headings. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
api-ref.md had two adjacent sections describing webhooks.delete (h3 at line 9573 and h4 at line 9684 pre-rename). Both documented the same method with the same signature. Keeping the h4 entry: it lives with the other webhook methods at h4 level, matches the surrounding template (includes Version info, concise Example, standard REST API link), and is what search results consistently pointed at. Discovered while working on the singular/plural heading rename in the previous commit. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Auditing api-ref.md against source for the Sphinx migration (#1832)
surfaced 20 headings that reference endpoint methods by the singular
form rather than the plural form actually bound on
Server. These havebeen drifting since well before Sphinx work started -- users Ctrl-F'ing
datasources.update_connectiondon't find the section today becausethe heading spells it
datasource.update_connection. The same auditturned up a duplicate
webhooks.deletesection (h3 and h4 bothdescribing the same method); folded here since it's discovered along
the way.
Behavior change
Docs only. Two commits:
Rename typo'd method headings. Only heading text and the code-sample
invocation line change; section prose is untouched.
datasource.*datasources.*subscription.*subscriptions.*webhook.*webhooks.*groupsets.*group_sets.*(snake_case, matchingcustom_views,flow_runs)Total: 20 headings renamed.
Remove duplicate
webhooks.deletesection. Two adjacent sectionsdescribed the same method (h3 at line 9573, h4 at line 9684). Kept the
h4 entry -- it lives with the other webhook methods at h4 level, matches
the surrounding template (includes Version info, standard REST API
link, concise Example).
Anchor slug impact. Kramdown regenerates anchor slugs from
headings, so the fragment URLs change (e.g.
#datasourceupdate_connection->#datasourcesupdate_connection).Searched across Salesforce-hosted repos for external references to the
old anchor slugs: none found. Existing external links to
tableau.github.io/server-client-python/docs/api-refall targetsection-level anchors (
#workbooks,#data-sources,#jobs,#server,#tableauauth-class) that this PR does not touch.Internal anchor links in api-ref.md itself: grepped for references to
the renamed method-heading slugs; none found.
Test plan
references_missingbucket went 20 -> 0; the 20 entries redistributedinto
reproducible(+9) andneeds_docstring(+11), matchingsource-side docstring coverage.
singular forms; none found.
renamed anchor slugs; none found.
api-ref.mdon the gh-pages Jekyll site;confirm the renamed sections render and their TOC entries regenerate.
🤖 Generated with Claude Code