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 #27

Merged
merged 32 commits into from
Dec 19, 2023
Merged

Docs #27

merged 32 commits into from
Dec 19, 2023

Conversation

RiesBen
Copy link
Contributor

@RiesBen RiesBen commented Nov 21, 2023 •
edited
Loading

Improving the docs:

  • Adding Tutorial (including filter func tutorial)
  • Install
  • index Welcome
  • API Fixes
  • Theory sections

This was linked to issues Nov 21, 2023
document filter function #13
Closed
Go over docs and improve #18
Closed
Docs: write usage example/Tutorial #23
Closed
Docs: Fix Docstring search for References #24
Closed
Docs: Installation #26
Closed
@codecov Codecov
Copy link

codecov bot commented Nov 21, 2023 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (3586724) 96.50% compared to head (f3b8b99) 96.49%.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main      #27      +/-   ##
==========================================
- Coverage   96.50%   96.49%   -0.01%     
==========================================
  Files          13       13              
  Lines         572      571       -1     
==========================================
- Hits          552      551       -1     
  Misses         20       20

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@RiesBen RiesBen self-assigned this Nov 26, 2023
@RiesBen RiesBen added the documentation Improvements or additions to documentation label Nov 26, 2023
This was linked to issues Nov 26, 2023
Docs: write section for atomMapping and Filters #20
Closed
Docs: write section for atom Scorers #22
Closed
@RiesBen RiesBen requested a review from IAlibay November 26, 2023 22:19
richardjgowers
richardjgowers reviewed Dec 13, 2023
View reviewed changes
Copy link
Contributor

@richardjgowers richardjgowers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looking good @RiesBen !

docs/tutorial/comparing_mappings.rst Outdated Show resolved Hide resolved
docs/tutorial/custom_filters.rst Show resolved Hide resolved
docs/tutorial/visualization_widget.rst Show resolved Hide resolved
docs/tutorial.rst Outdated Show resolved Hide resolved
docs/install.rst Outdated Show resolved Hide resolved
@RiesBen RiesBen merged commit e3b0d98 into main Dec 19, 2023
5 checks passed
@RiesBen RiesBen deleted the docs branch January 29, 2024 23:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@richardjgowers richardjgowers richardjgowers left review comments

@hannahbaumann hannahbaumann Awaiting requested review from hannahbaumann

@IAlibay IAlibay Awaiting requested review from IAlibay

Assignees

@RiesBen RiesBen

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
2 participants
@RiesBen @richardjgowers