Skip to content

Commit

Permalink
Add get_workspace_id to docgen blocklist (#549)
Browse files Browse the repository at this point in the history
## Changes
Doc generation is done automatically for all services in the
`WorkspaceClient` and `AccountClient` classes. However,
`get_workspace_id()` does not need to go through the same process, as
its docs will appear on the `WorkspaceClient` doc page anyways:
https://databricks-sdk-py--549.org.readthedocs.build/en/549/clients/workspace.html#databricks.sdk.WorkspaceClient.get_workspace_id.

## Tests
<!-- 
How is this tested? Please see the checklist below and also describe any
other relevant tests
-->

- [ ] `make test` run locally
- [ ] `make fmt` applied
- [ ] relevant integration tests applied
  • Loading branch information
mgyucht authored Feb 19, 2024
1 parent 94fc5e4 commit 94abc16
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/gen-client-docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ def class_methods(self, inst) -> list[MethodDoc]:

def service_docs(self, client_inst) -> list[ServiceDoc]:
client_prefix = 'w' if isinstance(client_inst, WorkspaceClient) else 'a'
ignore_client_fields = ('config', 'dbutils', 'api_client', 'files', 'get_workspace_client')
ignore_client_fields = ('config', 'dbutils', 'api_client', 'files', 'get_workspace_client', 'get_workspace_id')
all = []
for service_name, service_inst in inspect.getmembers(client_inst):
if service_name.startswith('_'):
Expand Down

0 comments on commit 94abc16

Please sign in to comment.