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

improve docs, rework exports #2220

Merged
merged 3 commits into from
Oct 18, 2023
Merged

improve docs, rework exports #2220

merged 3 commits into from
Oct 18, 2023

Conversation

PSeitz
Copy link
Contributor

@PSeitz PSeitz commented Oct 17, 2023

Add top level architecture overview, so new users can orient themselves
Move top level exports so docs are easier to read.

  • move snippet and advice
  • make indexer pub, remove indexer reexports
  • add top level architecture overview

Next steps would be to move segment and index out of core

move snippet and advice
make indexer pub, remove indexer reexports
@codecov-commenter
Copy link

codecov-commenter commented Oct 17, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (ecb9a89) 94.03% compared to head (ff05b66) 94.02%.
Report is 1 commits behind head on main.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2220      +/-   ##
==========================================
- Coverage   94.03%   94.02%   -0.02%     
==========================================
  Files         327      327              
  Lines       65156    65156              
==========================================
- Hits        61271    61262       -9     
- Misses       3885     3894       +9     
Files Coverage Δ
src/core/index.rs 87.53% <ø> (ø)
src/directory/mmap_directory.rs 86.27% <ø> (ø)
src/indexer/merge_operation.rs 100.00% <ø> (ø)
src/indexer/mod.rs 100.00% <ø> (ø)
src/indexer/segment_writer.rs 97.82% <ø> (ø)
src/lib.rs 99.05% <ø> (ø)
src/snippet/mod.rs 95.29% <100.00%> (ø)
src/termdict/mod.rs 71.83% <ø> (ø)
tokenizer-api/src/lib.rs 100.00% <ø> (ø)

... and 2 files with indirect coverage changes

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

@PSeitz PSeitz changed the title rework exports improved docs, rework exports Oct 18, 2023
@PSeitz PSeitz changed the title improved docs, rework exports improve docs, rework exports Oct 18, 2023
@PSeitz PSeitz merged commit c2b0469 into main Oct 18, 2023
4 checks passed
@PSeitz PSeitz deleted the rework_exports branch October 18, 2023 07:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants