Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Review all docstrings for consistency and errors #10

Open
6 of 10 tasks
Aesonus opened this issue Jun 25, 2024 · 0 comments
Open
6 of 10 tasks

Review all docstrings for consistency and errors #10

Aesonus opened this issue Jun 25, 2024 · 0 comments
Assignees
@Aesonus

Comments

@Aesonus
Copy link
Owner

Aesonus commented Jun 25, 2024 •
edited
Loading

Todo:

  • filter
  • filter.exc
  • filter.filter
  • storage
  • storage.exc
  • storage.index
  • storage.storage - May skip StorageABC as that is likely to be deprecated
  • join
  • pagination
  • visitor

These should all have method docs that conform to google style doc strings. In addition, they should use Arguments: instead of Args: and Keyword Arguments instead of Keyword Args:

Typing should not be in doc strings, but instead use PEP 484 type-hinting.

See Naploeon for more info.
Aesonus added a commit that referenced this issue Jun 25, 2024
@Aesonus
Update doc config #10
8a9e6a3 
Set the release document attribute to the project's `__version__`
attribute.
Aesonus added a commit that referenced this issue Oct 17, 2024
@Aesonus
Rewrite storage and visitor module docs
58bb01d 
Remove typing from method docs, change some wording, and spell out 'Arguments` instead
of 'Args'

Refs #10
Aesonus added a commit that referenced this issue Oct 17, 2024
@Aesonus
Rewrite the index module docs
00169ca 
Refs #10
Aesonus added a commit that referenced this issue Oct 17, 2024
@Aesonus
Revise the storage package docs
b7214ce 
Refs #10
Aesonus added a commit that referenced this issue Oct 17, 2024
@Aesonus
Rewrite the exc module docs
cd6afe2 
Revise the module docs and rewrite the docs for the `ConflictError` and `NotFoundError`
classes.

Refs #10
Aesonus added a commit that referenced this issue Oct 17, 2024
@Aesonus
Remove note from vistor.StatementVistor docs
71fc7ad 
Refs #10
@Aesonus Aesonus changed the title Publish Documentation on readthedocs.io Review all docstrings for consistency and errors Oct 17, 2024
@Aesonus Aesonus self-assigned this Oct 19, 2024
Aesonus added a commit that referenced this issue Oct 19, 2024
@Aesonus
Update conf.py to enforce docstring style
97ea0df 
Use google style doc strings for all doc strings.

Refs #10
Aesonus added a commit that referenced this issue Oct 19, 2024
@Aesonus
Change alchemical_storage.get_module docstring for consistency
1b4d957 
Refs #10
Aesonus added a commit that referenced this issue Oct 19, 2024
@Aesonus
Change filter.filter module docs for consistency
d713a6a 
Refs #10
Aesonus added a commit that referenced this issue Oct 19, 2024
@Aesonus
Remove incorrect note in filter.filter.FilterMap.visit_statement docs
fb2c98b 
Refs #10
Aesonus added a commit that referenced this issue Oct 19, 2024
@Aesonus
Change Args: to Arguments: throughout filter.filter module
35d821c 
Refs #10
Aesonus added a commit that referenced this issue Oct 19, 2024
@Aesonus
Update .filter.filter.FilterMap class doc description
bc0f0d0 
Refs #10
Aesonus added a commit that referenced this issue Oct 19, 2024
@Aesonus
Update .filter.filter.OrderByMap class doc description
7f27503 
Refs #10
Aesonus added a commit that referenced this issue Oct 19, 2024
@Aesonus
docs: revise .filter.filter.FilterMap see also note
8dca465 
Refs #10
Aesonus added a commit that referenced this issue Oct 19, 2024
@Aesonus
docs: add see also note to OrderByMap with ref to usage guide
46454cb 
Refs #10
Aesonus added a commit that referenced this issue Oct 19, 2024
@Aesonus
docs: remove type hints from .filter.filter module members' docstrings
fc45fda 
Refs #10
Aesonus added a commit that referenced this issue Oct 19, 2024
@Aesonus
docs: revise NullFilterMap docstring description with refs to the api
66ed16d 
Refs #10
Aesonus added a commit that referenced this issue Oct 19, 2024
@Aesonus
docs: remove return type docstring from all members of .filter.filter
9c29d53 
Refs #10
Aesonus added a commit that referenced this issue Oct 19, 2024
@Aesonus
docs: revise FilterMap.visit_statement docstring
71c4812 
Refs #10
Aesonus added a commit that referenced this issue Oct 19, 2024
@Aesonus
docs: revise OrderByMap.visit_statement docstring
0e2293c 
Refs #10
Aesonus added a commit that referenced this issue Oct 19, 2024
@Aesonus
docs: write NullFilterMap.visit_statement docstring
b48942d 
Refs #10
Aesonus added a commit that referenced this issue Oct 19, 2024
@Aesonus
docs: make storage package docstring more specific
d745be9 
Refs #10
Aesonus added a commit that referenced this issue Oct 19, 2024
@Aesonus
docs: revise .storage.index module docstring
b387b9f 
Refs #10
Aesonus added a commit that referenced this issue Oct 19, 2024
@Aesonus
docs: revise .storage.index.DatabaseIndex class docstring
10f7f10 
Refs #10
Aesonus added a commit that referenced this issue Oct 19, 2024
@Aesonus
docs: revise .storage.index.DatabaseIndex.get method docstring
d52f6ce 
Refs #10
Aesonus added a commit that referenced this issue Oct 19, 2024
@Aesonus
docs: revise all .storage.exc class docstrings
2aa462b 
- Revise module

- Revise `ConflictError`

- Revise `NotFoundError`

Refs #10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Aesonus Aesonus

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Aesonus