search

AMythicDev / minus

An asynchronous, runtime data feedable terminal paging library for Rust
https://crates.io/crates/minus/
Apache License 2.0
317 stars 23 forks source link

improving doc for `lib.rs` #123

Closed TornaxO7 closed 8 months ago

TornaxO7 commented 9 months ago

continues https://github.com/arijit79/minus/pull/122

AMythicDev commented 9 months ago

I think we should include a common patterns section or something like that to give a brief example of some of the major features of minus and then direct them to the respective modules which concerns that stuff.

TornaxO7 commented 9 months ago

I'm unsure about that because this might become complicated for the reader. When I started to use your library, your example section was helping me a lot and I then just used the search bar to get more information about the structs. In my opinion that was fine and also good.

AMythicDev commented 9 months ago

Well then let's drop this idea.

TornaxO7 commented 9 months ago

Well then let's drop this idea.

Nono, you can create a suggestion-structure if you want. That's just my opinion! It doesn't mean that I'm right :)

AMythicDev commented 9 months ago

Nah I will add them in the individual modules so that's it's easier for the reader to understand the stuff. If later down the line I feel that we need something like this, I will just add it then.

AMythicDev commented 8 months ago

Merged.