typedb/typedb-docs

docs on options include two incorrect keys and need usage examples

Opened this issue · 2 comments

Description

In the client python docs section on options,

  1. two option names are out of date.
  2. it should provide an example of how to instantiate the options object

Location of Content

https://docs.vaticle.com/docs/client-api/python#options

Expected Content

  1. correct option names
  2. an example of how to instantiate the options object

Actual Content

the listed options include two which have since changed name:
batch_size (now prefetch_size)
schema_lock_timeout_acquire_millis (now schema_lock_acquire_timeout_millis)

Additional information

This likely also applies to other places in the docs describing options

We should add an example of instantiating TypeDBOptions to every language.

The options were updated in #583.
An example of usage would be useful here.

Python:

TB = TypeDBOptions.core()  # Initialising a new set of options
TB.infer = True  # Enabling inference in this new set of options

...

with session.transaction(TransactionType.READ, TB) as transaction: