Skip to content

Python driver docs reference an undefined enum #883

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
nicholasphair opened this issue Jun 16, 2024 · 2 comments · Fixed by #884
Closed

Python driver docs reference an undefined enum #883

nicholasphair opened this issue Jun 16, 2024 · 2 comments · Fixed by #884
Labels
status: solved

Comments

@nicholasphair
Copy link
Contributor

Description

The python driver documentation references an enum that is not defined.

Location of Content

Link of Content

Expected Content

class Edition(Enum):
    Cloud = 1
    Core = 2

DB_NAME = "sample_app_db"
SERVER_ADDR = "127.0.0.1:1729"
TYPEDB_EDITION = Edition.Core
CLOUD_USERNAME = "admin"
CLOUD_PASSWORD = "password"

Actual Content

DB_NAME = "sample_app_db"
SERVER_ADDR = "127.0.0.1:1729"
TYPEDB_EDITION = Edition.Core
CLOUD_USERNAME = "admin"
CLOUD_PASSWORD = "password"

Additional information

You can see the issue in the public docs.
@nicholasphair nicholasphair changed the title Python driver docs reference and undefined enum Python driver docs reference an undefined enum Jun 16, 2024
@nicholasphair nicholasphair mentioned this issue Jun 16, 2024
Merged
cxdorn added a commit that referenced this issue Jun 17, 2024
@nicholasphair @cxdorn
Remove enum tag in python driver docs. (#884)
7241c87 
## What is the goal of this PR?

Resolves #883.

## What are the changes implemented in this PR?

Removes the enum tag from `sample.py` and include the `Edition` enum in
the constants tag.

This is consistent with the other driver examples (e.g.,
[Java](https://github.com/vaticle/typedb-docs/blob/4a52a99237ed3269230e3a3579ce7e801f91a584/drivers-src/modules/ROOT/partials/tutorials/java/src/main/java/org/example2/Main.java#L20-L32),
[CPP](https://github.com/vaticle/typedb-docs/blob/4a52a99237ed3269230e3a3579ce7e801f91a584/drivers-src/modules/ROOT/partials/tutorials/cpp/main.cpp#L8-L15)).

---------

Co-authored-by: Christoph Dorn <[email protected]>
@cxdorn
Copy link
Member

cxdorn commented Jun 17, 2024

@nicholasphair thanks for pointing this out!

@cxdorn
Copy link
Member

cxdorn commented Jun 17, 2024

fixed

@cxdorn cxdorn closed this as completed Jun 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
status: solved
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Remove enum tag in python driver docs. nicholasphair/typedb-docs
3 participants
@cxdorn @nicholasphair @typedb-bot