Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cognite/client/_api/datapoints.py
Original file line number Diff line number Diff line change
Expand Up @@ -589,7 +589,7 @@ async def __call__(
chunk_size_time_series: int | None = None,
return_arrays: bool = True,
) -> AsyncIterator[DatapointsArray | DatapointsArrayList | Datapoints | DatapointsList]:
"""`Iterate through datapoints in chunks, for one or more time series. <https://api-docs.cognite.com/20230101/tag/Time-series/operation/getMultiTimeSeriesDatapoints>`_
"""`Iterate through datapoints in chunks, for one or more time series <https://api-docs.cognite.com/20230101/tag/Time-series/operation/getMultiTimeSeriesDatapoints>`_.

Note:
Control memory usage by specifying ``chunk_size_time_series``, how many time series to iterate simultaneously and ``chunk_size_datapoints``,
Expand Down
4 changes: 2 additions & 2 deletions cognite/client/_sync_api/datapoints.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
===============================================================================
830266fb5fd8d205e7c1163175ba904e
7a135c3c2b851240417e3902f71b5222
This file is auto-generated from the Async API modules, - do not edit manually!
===============================================================================
"""
Expand Down Expand Up @@ -91,7 +91,7 @@ def __call__(
return_arrays: bool = True,
) -> Iterator[DatapointsArray | DatapointsArrayList | Datapoints | DatapointsList]:
"""
`Iterate through datapoints in chunks, for one or more time series. <https://api-docs.cognite.com/20230101/tag/Time-series/operation/getMultiTimeSeriesDatapoints>`_
`Iterate through datapoints in chunks, for one or more time series <https://api-docs.cognite.com/20230101/tag/Time-series/operation/getMultiTimeSeriesDatapoints>`_.

Note:
Control memory usage by specifying ``chunk_size_time_series``, how many time series to iterate simultaneously and ``chunk_size_datapoints``,
Expand Down
3 changes: 2 additions & 1 deletion docs/source/_ext/autosummary.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ def run(self):
methods = [
method_name
for method_name in attributes
if callable(getattr(obj, method_name)) and not method_name.startswith("_")
if callable(getattr(obj, method_name))
and (not method_name.startswith("_") or method_name == "__call__")
]
content.extend([f"{name}.{method}" for method in methods])
if "attributes" in self.options:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/_templates/custom-accessor-template.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{% if objname in headings %}
{{headings[objname] | escape | underline }}
{% else %}
{{ objname.split('.')[-1].replace('_', ' ').title() | escape | underline }}
{{ objname.split('.')[-1].replace('_', ' ').strip().title() | escape | underline }}
{% endif %}

.. currentmodule:: {{ module }}
Expand Down
4 changes: 4 additions & 0 deletions docs/source/_templates/custom-automethods-template.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@
.. autosummary::
:toctree:
:template: custom-accessor-template.rst

{% if "__call__" in members %}
{{ name }}.__call__
{% endif %}
{% for item in methods %}
{%- if item != "__init__" %}
{{ name }}.{{ item }}
Comment thread
MortGron marked this conversation as resolved.
Expand Down
Loading
Loading