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

improving doc for lib.rs #123

Merged
merged 2 commits into from
Dec 19, 2023
Merged

Conversation

TornaxO7
Copy link
Contributor

@TornaxO7 TornaxO7 commented Dec 18, 2023

continues #122

@AMythicDev
Copy link
Owner

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
Copy link
Contributor Author

TornaxO7 commented Dec 18, 2023

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
Copy link
Owner

Well then let's drop this idea.

@TornaxO7
Copy link
Contributor Author

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
Copy link
Owner

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 AMythicDev merged commit 34c8ba8 into AMythicDev:main Dec 19, 2023
6 checks passed
@AMythicDev
Copy link
Owner

Merged.

@TornaxO7 TornaxO7 deleted the improve-doc-for-lib branch December 19, 2023 09:31
@AMythicDev AMythicDev added the A-docs Improvements or additions to documentation label Dec 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants