Skip to content

Commit

Permalink
[#6577] docs: fix param typo from 'type' to 'catalog_type' (#6634)
Browse files Browse the repository at this point in the history
### What changes were proposed in this pull request?

Fix parameter typo for `create_catalog` function in `hadoop-catalog`
fileset documentation and `manage-fileset` and `manage-model`. Change
parameter typo from `type` to `catalog_type`.

### Why are the changes needed?

Incorrect parameter name in the documentation.

Fix: #6577

### Does this PR introduce _any_ user-facing change?

No.

### How was this patch tested?

None.

Co-authored-by: AndreVale69 <[email protected]>
Co-authored-by: Jerry Shao <[email protected]>
  • Loading branch information
3 people authored Mar 7, 2025
1 parent 53b65f7 commit 7ea5ee5
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/hadoop-catalog-with-adls.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ adls_properties = {
}

adls_properties = gravitino_client.create_catalog(name="example_catalog",
type=Catalog.Type.FILESET,
catalog_type=Catalog.Type.FILESET,
provider="hadoop",
comment="This is a ADLS fileset catalog",
properties=adls_properties)
Expand Down
2 changes: 1 addition & 1 deletion docs/hadoop-catalog-with-gcs.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ gcs_properties = {
}

gcs_properties = gravitino_client.create_catalog(name="test_catalog",
type=Catalog.Type.FILESET,
catalog_type=Catalog.Type.FILESET,
provider="hadoop",
comment="This is a GCS fileset catalog",
properties=gcs_properties)
Expand Down
2 changes: 1 addition & 1 deletion docs/hadoop-catalog-with-oss.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ oss_properties = {
}

oss_catalog = gravitino_client.create_catalog(name="test_catalog",
type=Catalog.Type.FILESET,
catalog_type=Catalog.Type.FILESET,
provider="hadoop",
comment="This is a OSS fileset catalog",
properties=oss_properties)
Expand Down
2 changes: 1 addition & 1 deletion docs/hadoop-catalog-with-s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ s3_properties = {
}

s3_catalog = gravitino_client.create_catalog(name="test_catalog",
type=Catalog.Type.FILESET,
catalog_type=Catalog.Type.FILESET,
provider="hadoop",
comment="This is a S3 fileset catalog",
properties=s3_properties)
Expand Down
2 changes: 1 addition & 1 deletion docs/manage-fileset-metadata-using-gravitino.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Catalog catalog = gravitinoClient.createCatalog("catalog",
```python
gravitino_client: GravitinoClient = GravitinoClient(uri="http://localhost:8090", metalake_name="metalake")
catalog = gravitino_client.create_catalog(name="catalog",
type=Catalog.Type.FILESET,
catalog_type=Catalog.Type.FILESET,
provider="hadoop",
comment="This is a Hadoop fileset catalog",
properties={"location": "/tmp/test1"})
Expand Down
2 changes: 1 addition & 1 deletion docs/manage-model-metadata-using-gravitino.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Catalog catalog = gravitinoClient.createCatalog(
```python
gravitino_client: GravitinoClient = GravitinoClient(uri="http://localhost:8090", metalake_name="example")
catalog = gravitino_client.create_catalog(name="model_catalog",
type=Catalog.Type.MODEL,
catalog_type=Catalog.Type.MODEL,
provider=None,
comment="This is a model catalog",
properties={"k1": "v1"})
Expand Down

0 comments on commit 7ea5ee5

Please sign in to comment.