[GitHub] [avro] sarutak opened a new pull request, #2475: AVRO-3849: [Rust] Use cargo-rdme instead of cargo-readme

["sarutak (via GitHub)" <gi...@apache.org>]

sarutak opened a new pull request, #2475:
URL: https://github.com/apache/avro/pull/2475

   AVRO-3849
   
   ## What is the purpose of the change
   This PR fixes an issue that `make readme` doesn't work.
   
   `avro/README.md` is intended to be created from the doc comment in `avro/src/lib.rs` by `make readme`.
   But it doesn't work due to some reasons.
   The main reason is `cargo-readme` currently used doesn't work with workspace.
   Also, `cargo-readme` is not maintained for a long time (the last commit is Apr 1, 2020).
   
   So, I propose to use `cargo-rdme`.
   https://github.com/orium/cargo-rdme
   
   After this change, we can create `avro/README.md` from `avro/src/lib/rs` by the following instructions.
   ```
   $ cargo install cargo-rdme
   $ make readme
   ```
   
   ## Verifying this change
   I confirmed `avro/README.md` generated by `make readme` is almost the same as it was before this change.
   
   ## Documentation
   
   - Does this pull request introduce a new feature? (no)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@avro.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [avro] martin-g commented on pull request #2475: AVRO-3849: [Rust] Use cargo-rdme instead of cargo-readme

["martin-g (via GitHub)" <gi...@apache.org>]

martin-g commented on PR #2475:
URL: https://github.com/apache/avro/pull/2475#issuecomment-1704713612

   Thank you, @sarutak !


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@avro.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [avro] martin-g merged pull request #2475: AVRO-3849: [Rust] Use cargo-rdme instead of cargo-readme

["martin-g (via GitHub)" <gi...@apache.org>]

martin-g merged PR #2475:
URL: https://github.com/apache/avro/pull/2475


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@avro.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [avro] KalleOlaviNiemitalo commented on a diff in pull request #2475: AVRO-3849: [Rust] Use cargo-rdme instead of cargo-readme

["KalleOlaviNiemitalo (via GitHub)" <gi...@apache.org>]

KalleOlaviNiemitalo commented on code in PR #2475:
URL: https://github.com/apache/avro/pull/2475#discussion_r1313721889


##########
lang/rust/avro/README.md:
##########
@@ -33,7 +35,7 @@ data structures and a compact, fast, binary data format.
 
 All data in Avro is schematized, as in the following example:
 
-```
+```text

Review Comment:
   Would ```` ```json ```` work here?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@avro.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org