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

doc: adds documentation to prepare for 0.0.5 release #25

Merged
merged 30 commits into from
May 24, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
434d3bf
chore: remove redundant doc links
arindas Dec 24, 2023
e3061d5
doc: adds documentation for top-level modules under crate::storage
arindas Dec 24, 2023
99d7e22
doc: adds documentation for the commit-log module
arindas Dec 29, 2023
3cdae60
doc: adds documentation for the index module
arindas Jan 13, 2024
0d2f3fb
style: rewrites SegmentedLog::new to reduce Segment::new calls
arindas Feb 7, 2024
0af1217
chore: updates generational-cache dep version
arindas Feb 7, 2024
ed3faf2
chore: updates generational-cache dep version
arindas Feb 8, 2024
0084f4a
style: conforms common::split module structure to follow repository s…
arindas Feb 8, 2024
1d994b2
doc: adds documentation for Index struct
arindas Feb 8, 2024
b1de935
doc: updates README and Index documentation
arindas Feb 9, 2024
b70ba84
doc: documents segmented_log::MetaWithIdx
arindas Feb 26, 2024
f95fb55
chore: adds documentation for SegmentedLogError
arindas Feb 27, 2024
95732bd
style: remove redundant unit return from unit closure
arindas Feb 27, 2024
ff8b4d8
doc: adds documentation for the SegmentedLog struct
arindas Feb 27, 2024
78f038e
doc: adds an example for SegmentedLog
arindas Feb 27, 2024
52d2ee4
doc: documents SegmentedLog::new
arindas Feb 28, 2024
a9e2017
doc: adds documentation for convenience macros
arindas Feb 28, 2024
61b83ef
doc: adds documentation for various read() APIs
arindas Feb 28, 2024
0d452c2
chore: corrects typo
arindas Feb 28, 2024
47f92d6
style: refactor CacheOp and CacheOpKind to single sum type SegmentInd…
arindas Mar 2, 2024
9bfbea3
doc: adds documentation for stream_* and seq_read APIs
arindas Mar 2, 2024
c3d2e13
chore: fix typos
arindas Mar 6, 2024
3c4d0ba
doc: documents remaining methods for SegmentedLog
arindas Mar 6, 2024
a139f28
doc: adds documentation for IndexError and Index::* functions
arindas Mar 16, 2024
89e863c
doc: adds missing documenatation for Index::* functions
arindas May 1, 2024
ec7874f
doc: documents RecordHeader and Store in segmented_log::store
arindas May 24, 2024
09f67d2
doc: documents store::StoreError
arindas May 24, 2024
e4900cd
doc: documents segmented_log::segment::Segment
arindas May 24, 2024
c16dbe1
chore: update crate version
arindas May 24, 2024
d363e69
chore: update examples path in README
arindas May 24, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chore: updates generational-cache dep version
  • Loading branch information
arindas committed Feb 8, 2024
commit ed3faf2f70fa34fe5b733c4263a9152efe9f2c96
4 changes: 2 additions & 2 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ tower-service = "0.3.2"
num = "0.4.0"
futures-time = "3.0.0"
async-io = "1.13.0"
generational-cache = "0.2.1"
generational-cache = "0.2.2"

[lib]
name = "laminarmq"
Expand Down