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

Minor readme improvments #442

Merged
merged 3 commits into from
Dec 1, 2024
Merged

Minor readme improvments #442

merged 3 commits into from
Dec 1, 2024

Conversation

tkr-sh
Copy link
Contributor

@tkr-sh tkr-sh commented Nov 29, 2024

  • Put the release process in it's own file
  • Removed extra whitespaces in a rust code block

@jeertmans
Copy link
Collaborator

Hi @tkr-sh, thanks for your contribution!

I like when code is formatted, so cleaning up examples is always good. Did you do that manually, or did you use a tool?

Regarding the creation of another file, I don't really see the benefit. This is probably better to put this in the book, under a Contributing section, for example.

@jeertmans jeertmans added enhancement New feature or request documentation Related to the library docs labels Nov 30, 2024
@tkr-sh
Copy link
Contributor Author

tkr-sh commented Nov 30, 2024

I personally don't think that it's that a good idea to have that in the README, and here are some other projects that use a separate file:

and there are probably a lot more. But, if you don't agree, it's ok and I won't argue. Putting it in a book is also ok!

Concerning the "cleaning up", I just noticed that there were spaces at the start of the line, so I just "manually" deleted them

@jeertmans
Copy link
Collaborator

I personally don't think that it's that a good idea to have that in the README, and here are some other projects that use a separate file:

and there are probably a lot more. But, if you don't agree, it's ok and I won't argue. Putting it in a book is also ok!

Ok that makes sense, let's keep it that way, and we will see in the future if we write a contributing guide or not :-)

Concerning the "cleaning up", I just noticed that there were spaces at the start of the line, so I just "manually" deleted them

Ok, I guess it was introduced by mistake in the past, but they look legit, so I trust the spacing must be consistent!

Thanks for your contribution!

@jeertmans jeertmans merged commit 837d5bf into maciejhirsz:master Dec 1, 2024
2 checks passed
jeertmans pushed a commit that referenced this pull request Dec 2, 2024
* chore: move the release process to its own file

* chore: remove extra whitespace in rust code block

* chore: better with a title :) !
jeertmans added a commit that referenced this pull request Dec 2, 2024
* Minor readme improvments (#442)

* chore: move the release process to its own file

* chore: remove extra whitespace in rust code block

* chore: better with a title :) !

* chore(book): add simple calculator example (#439)

* chore(book): add simple calculator example

* fix(book): footnote

* Apply suggestions from code review

Co-authored-by: Jérome Eertmans <[email protected]>

* Partially apply a suggestion from code review

* fix(book): add clone instructions to the simple calculator example

* chore(book): add the contributor info to the simple calculator example

---------

Co-authored-by: ynn <[email protected]>
Co-authored-by: Jérome Eertmans <[email protected]>

* chore(release): bump version

* chore(release): replace version in docs

* chore(lint): apply Clippy and Rustfmt

* chore(lint): allow needless lifetime

---------

Co-authored-by: tk <[email protected]>
Co-authored-by: ynn <[email protected]>
Co-authored-by: ynn <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Related to the library docs enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants