-
Katy asks nicely that Dan has a go at these, because Dan loves copyediting.
Plan is to make an issue for anything that isn't straight copyedits, e.g., confusing examples.
-
Most docstrings don't have a description of the attributes the class defines (see, e.g., `Cube` or `Maps`). A few, such as `Bin`, are probably ok. We should go through all the docstrings and make sure…
-
[DOC: Enforce Numpy Docstring Validation (Parent Issue) #58063](https://github.com/pandas-dev/pandas/issues/58063)
Pandas has a script for validating docstrings in code_checks.sh. Currently, some m…
-
This is an overview of the outstanding issues regarding G sets, and is meant to track their current status.
- [ ] We need to improve computation of GAP orbits on Julia objects (see #722). The obsta…
-
### The Feature
Move to enforcing Google Python Style Guide across repo.
- [x] Add parent `check_code_quality` test group as a separate part of ci/cd pipeline
- [x] Add `ruff` check to circle …
-
Move the examples from the readme to the docs
-
When trying to buld the docs for a package I ran across this error message after running `docs/make.jl`:
```
[ Info: SetupBuildDirectory: setting up build directory.
[ Info: Doctest: running doct…
-
I recommend doing these in small batches, and reviewing the patterns already in use for the existing docstrings. I don't yet have a style guide in mind (beyond what's enforced by flake8-docstrings); m…
-
### Environment
- VSCode Version: 1.8.1
- OS Version: OS X
- Clojure Extension Version: 0.1.0
### Description
Noticed when jumping to definition for clojure.core/println that resolving docstrin…
-
I would love it if a table declared as
```py
class MyTable(BaseModel):
"""doc string explaining the table """
field = Column(Integer)
```
would show the docstring in the diagram right un…