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.

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

[DOCS] Refactor expressions docs layout #1816

Merged
merged 10 commits into from
Feb 1, 2024
Merged

[DOCS] Refactor expressions docs layout #1816

merged 10 commits into from
Feb 1, 2024

Conversation

jaychia
Copy link
Contributor

@jaychia jaychia commented Jan 24, 2024

Flattened Expressions API docs

image

DataTypes and Series API docs have been unnested into just a flat class-level page

image image

More todos for cleanups that can be done as follow-up PRs:

  • We can probably cleanup our magic methods such as Expression.__add__ as a dedicated .add() method, and then document the use of the magic method in there.
  • We will need much better docstrings (+ examples) on every method and function to make our doc really +++strong.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 24, 2024
Copy link

codecov bot commented Jan 24, 2024

Codecov Report

Attention: 10 lines in your changes are missing coverage. Please review.

Comparison is base (854037e) 85.08% compared to head (be547e7) 85.60%.
Report is 5 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1816      +/-   ##
==========================================
+ Coverage   85.08%   85.60%   +0.51%     
==========================================
  Files          55       55              
  Lines        5713     6079     +366     
==========================================
+ Hits         4861     5204     +343     
- Misses        852      875      +23     
Files Coverage Δ
daft/dataframe/__init__.py 100.00% <100.00%> (ø)
daft/dataframe/dataframe.py 88.26% <100.00%> (+0.06%) ⬆️
daft/__init__.py 24.24% <0.00%> (ø)
daft/expressions/expressions.py 90.86% <57.14%> (-1.83%) ⬇️

... and 11 files with indirect coverage changes

@jaychia jaychia merged commit 59af587 into main Feb 1, 2024
41 of 42 checks passed
@jaychia jaychia deleted the jay/expressions-docs branch February 1, 2024 18:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant