cognitedata / cognitedata/cognite-sdk-python
Update documentation to avoid `filters as flt, aggregations as aggs` and spell them out instead
Open
@andeplane is already working on this.
Since Feb 21, 2024.
documentation
- Dominant language
- Python
- Stars
- 92
- Forks
- 38
- Avg merge
- 2d 9h
- Merged PRs (30d)
- 42
Description
Describe the bug
In many of the examples in the documentation, we have imports like ... filters as flt. It looks inspired from import matplotlib.pyplot as plt, but doesn't add much value imo, and seems like it might make AI confused in code generation (also me!)
I'd like to update the documentation to import them with filters and aggregations spelled out.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.