Skip to content

Standardized or updated documentation and naming conventions#328

Merged
dvdjlaw merged 62 commits intomasterfrom
update-docstrings
Oct 9, 2020
Merged

Standardized or updated documentation and naming conventions#328
dvdjlaw merged 62 commits intomasterfrom
update-docstrings

Conversation

@dvdjlaw
Copy link
Copy Markdown
Member

@dvdjlaw dvdjlaw commented Oct 9, 2020 •
edited
Loading

  • Added more ignores for flake8 to accept proper black formatting
  • Renamed modules in core to be more consistent
  • Standardized or improved docstrings across data-describe
  • Standardized most of core features to use the Widget class as output
  • Renamed internal attribute of Backend class
  • Added developer guide
  • Made Example notebooks sorted by alphabetical order in resulting documentation
  • Updated/added manual documentation (Introduction, User Guide)
  • CorrelationMatrixWidget -> CorrelationWidget
  • KmeansClusterWidget and HDBSCANClusterWidget -> ClusterWidget

dvdjlaw added 30 commits October 5, 2020 17:37
@dvdjlaw
Update cluster docstrings
22dd36c
@dvdjlaw
Update package docstring for backend
669b5b0
@dvdjlaw
Make backend class private
c7b7cc2
@dvdjlaw
Clean up backends logic
6350637
@dvdjlaw
Update compat package docstring
681c511
@dvdjlaw
Create note section in backend docstring
39cce39
@dvdjlaw
Update compat docstrings
f1abc66
@dvdjlaw
Lint with darglint and update docstrings
564aea8
@dvdjlaw
Update config docstrings
cb2497c
@dvdjlaw
Remove old metrics module
75b458f
@dvdjlaw
Update misc docstrings
a10c67f
@dvdjlaw
Update requires to private
a3743fe
@dvdjlaw
Update rename references
9aae950
@dvdjlaw
Fix docstrings for metrics subpackage
1b600ee
@dvdjlaw
Update correlation docstrings
aa3fd84
@dvdjlaw
Update docstrings for core
2dfd2fd
@dvdjlaw
Update privacy docstrings
e0df21a
@dvdjlaw
Update text docstrings
86d6c9e
@dvdjlaw
Update widget docstring
2889d91
@dvdjlaw
Rename correlations module
1b3314b
@dvdjlaw
Rename data_heatmap module
f14e727
@dvdjlaw
Rename scatter_plot module
d41c6f6
@dvdjlaw
Rename time_series module
b307dc9
@dvdjlaw
Update other references to time series
baf6bad
@dvdjlaw
Update developer guide
cec3f98
@dvdjlaw
Update docstring for scatter modes
00756fb
@dvdjlaw
Rename and make private aggregation methods in summary
196f437
@dvdjlaw
Fix time series references
3e03403
@dvdjlaw
Rename backend attribute
b48867c
@dvdjlaw
Update test checking for typeerror
89e7ccb
dvdjlaw added 27 commits October 6, 2020 19:42
@dvdjlaw
Update doc organization
2e663cf
@dvdjlaw
Fix importance
c1973b8
@dvdjlaw
Sort example notebooks
b677bea
@dvdjlaw
Update cluster widget structure
fe076dd
@dvdjlaw
Update correlation widget structure
68f154f
@dvdjlaw
Document private members
aa33803
@dvdjlaw
Add doc info to dev guide
0e9aef9
@dvdjlaw
Update data heatmap
dbcf7b5
@dvdjlaw
Update docstring
8ad9563
@dvdjlaw
Update plotly object references in tests
d382b26
@dvdjlaw
Update/expand docstrings
3292c48
@dvdjlaw
Don't document private members
f87dc6e
@dvdjlaw
Expand intro/install docs
b94bbbe
@dvdjlaw
Update distribution organization
cfa6eac
@dvdjlaw
Update heatmap organization
51146c6
@dvdjlaw
Polish importance docs
f485f1b
@dvdjlaw
Add widget API for data summary
d086565
@dvdjlaw
Update scatter plot
0749ca1
@dvdjlaw
Fix type hint
3d014e0
@dvdjlaw
Fix warning in scatter plot instead of raise
acf447d
@dvdjlaw
Fix pytest to check for warning
4a1b1d1
@dvdjlaw
Minor touch-ups to docstrings
4cfcae5
@dvdjlaw
Add user guide
dc886f3
@dvdjlaw
Re-enable cluster tests
4707d66
@dvdjlaw
Rename tutorial
a6682fb
@dvdjlaw
Clarify wording
c8a4f17
@dvdjlaw
Update renamed quick start notebook in doc build
fc5af8f
@dvdjlaw dvdjlaw changed the title Update docstrings Standardized or updated documentation and naming conventions Oct 9, 2020
@dvdjlaw dvdjlaw merged commit 9f3635b into master Oct 9, 2020
@dvdjlaw dvdjlaw deleted the update-docstrings branch October 9, 2020 22:35
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.

1 participant

@dvdjlaw