diff --git a/doc/Examples.rst b/doc/Examples.rst index eef2976aa3122edae7a5edf268075c0b93f5b5ec..9bc08444b1ca88ddc1feee85e632351d1dba4661 100644 --- a/doc/Examples.rst +++ b/doc/Examples.rst @@ -19,6 +19,7 @@ You can print the full version of the server that you are connected to (and therby test the connection) via: .. code:: cpp + // get version info of the server connection.RetrieveVersionInfo() const auto &v_info = connection->GetVersionInfo(); @@ -57,8 +58,9 @@ you want to retrieve an Entity with id=123. This is done via You can then use the getter methods like :cpp:any:`GetId<caosdb::entity::Entity::GetId>`, -:cpp:any:`GetParents<caosdb::entity::Entity::GetParents>`, or :cpp:any:`GetProperties`<caosdb::entity::Entity::GetProperties>` to get the -name, the parents, or the properties of the retrieved entity. +:cpp:any:`GetParents<caosdb::entity::Entity::GetParents>`, or +:cpp:any:`GetProperties`<caosdb::entity::Entity::GetProperties>` to get the name, the parents, or +the properties of the retrieved entity. Retrieving multiple entities works in the same way. Type @@ -83,9 +85,9 @@ transaction manually. This is done by transaction->RetrieveById("1233"); auto status = transaction->Execute(); -A result set can be obtained -via :cpp:any:`GetResultSet`<caosdb::transaction::Transaction::GetResultSet>` which contains the resulting entities -and can, e.g., be checked for length. +A result set can be obtained via +:cpp:any:`GetResultSet`<caosdb::transaction::Transaction::GetResultSet>` which contains the +resulting entities and can, e.g., be checked for length. Execute queries --------------- @@ -147,6 +149,7 @@ Insert, update and delete operations function the same way. The respective task is added to a transaction and the transaction is executed. .. code:: cpp + const auto &connection = caosdb::connection::ConnectionManager::GetDefaultConnection(); @@ -202,7 +205,7 @@ task is added to a transaction and the transaction is executed. Up- and Download a file ---------------- +----------------------- .. code:: cpp diff --git a/doc/conf.py.in b/doc/conf.py.in index c359c11e4d785a840761e50e93c2787d86312a43..202d9d294c01dba07818c7a5efb2fbb65dec7840 100644 --- a/doc/conf.py.in +++ b/doc/conf.py.in @@ -46,7 +46,7 @@ extensions = [ 'sphinx_sitemap', 'sphinx.ext.inheritance_diagram', 'breathe', - "recommonmark" # For markdown files. + "recommonmark", # For markdown files. ] # Add any paths that contain templates here, relative to this directory.