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

docs: Remove database & SQL references, remove title underlines to comply with Google docstring format, fix patito.Field docstring, error on front page #72

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

docs: Remove database & SQL references, remove title underlines to comply with Google docstring format, fix patito.Field docstring, error on front page #72

wants to merge 6 commits into from

Conversation

nameloCmaS
Copy link

Fixes various issues with the documentation:

  1. Remove database & SQL references - these were removed in Add support for pydantic 2.0, polars 0.20.10 and remove duckdb support #32. Delete files and references in .rst files (I had read the whole documentation for the database module thinking that it was a nice feature, and realised it had been removed - so thought I should help out and remove it for you!)
  2. Remove title underlines to comply with Google docstring format to remove sphinx warnings.
  3. fix patito.Field docstring.
  4. Removes visible backticks on front page of docs.

This leaves the below sphinx warnings, tried importing FrameInitTypes in different modules, but didn't help:

WARNING: Failed guarded type import with ModuleNotFoundError("No module named 'deltalake'")
WARNING: Cannot resolve forward reference in type annotations of "patito.DataFrame": name 'FrameInitTypes' is not defined
WARNING: Cannot resolve forward reference in type annotations of "patito.Model.DataFrame": name 'FrameInitTypes' is not defined

@nameloCmaS
docs: Remove Database & SQL references
deccd67 
These pieces of code the docs refer to were removed as part of JakobGM#32 (commit 054d034)
@nameloCmaS
Docs: Bulk remove title underlines
18b26d0 
Title underlines are not part of the Google spec docstring which is used throughout, causes many "WARNING: Title underline too short" in Sphinx which masks other warnings.
@nameloCmaS
docs: Remove old repository reference
d21ded5
@nameloCmaS
docs: Remove .rst database parts following earlier removal of files
0033c44
@nameloCmaS
docs: Fix pitito.Field docstring
2db1e6d 
Returns added as was automatically added in the wrong location and caused a warning.

Moved docstring to the helper class as this is how sphinx obtains the docstring for partial functions; neatens code as the docstring class and assignment is no longer necessary.

Corrected out of date Pydantic docs link, added api and guidance links, added link to return type. Reworded slightly.
@nameloCmaS
docs: Fix visible backticks on front page of docs
d6b65d7
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@nameloCmaS