You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avro.apache.org by "sarutak (via GitHub)" <gi...@apache.org> on 2023/09/20 23:11:09 UTC

[GitHub] [avro] sarutak opened a new pull request, #2510: AVRO-3868: [Rust][CI] Check consistency between the doc comment in lib.rs and README.md

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

   AVRO-3868
   
   ## What is the purpose of the change
   This PR proposes to add a consistency check between the doc comment in `avro/src/lib.rs` and `avro/README.md`.
   AVRO-3849 added cargo-rdme so it's nice if we can check the consistency between them.
   
   ## Verifying this change
   Done by GitHub Actions.
   
   ## 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 #2510: AVRO-3868: [Rust][CI] Check consistency between the doc comment in lib.rs and README.md

Posted by "martin-g (via GitHub)" <gi...@apache.org>.
martin-g commented on PR #2510:
URL: https://github.com/apache/avro/pull/2510#issuecomment-1728933124

   The change looks good but installing `cargo-rdme` takes 5 mins ... This makes the CI 5 mins slower ...
   I wonder how useful this is. Most of the users use [docs.rs](https://docs.rs/apache-avro/latest/apache_avro/). An out-of-date README.md is not a big deal.


-- 
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] sarutak commented on pull request #2510: AVRO-3868: [Rust][CI] Check consistency between the doc comment in lib.rs and README.md

Posted by "sarutak (via GitHub)" <gi...@apache.org>.
sarutak commented on PR #2510:
URL: https://github.com/apache/avro/pull/2510#issuecomment-1729209440

   > I wonder how useful this is. Most of the users use [docs.rs](https://docs.rs/apache-avro/latest/apache_avro/). An out-of-date README.md is not a big deal.
   
   I think an out-of-date `README.md` is not a big deal too but an out-of-date [doc.rs](https://docs.rs/apache-avro/latest/apache_avro/) is an issue.
   It really happened before 7ff2d7a075debbf7e038f0a4f0674.
   
   Making CI slower is indeed not good so how about caching `cargo-rdme`?


-- 
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 #2510: AVRO-3868: [Rust][CI] Check consistency between the doc comment in lib.rs and README.md

Posted by "martin-g (via GitHub)" <gi...@apache.org>.
martin-g merged PR #2510:
URL: https://github.com/apache/avro/pull/2510


-- 
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] sarutak commented on pull request #2510: AVRO-3868: [Rust][CI] Check consistency between the doc comment in lib.rs and README.md

Posted by "sarutak (via GitHub)" <gi...@apache.org>.
sarutak commented on PR #2510:
URL: https://github.com/apache/avro/pull/2510#issuecomment-1730223029

   `cargo-rdme` seems to be cached as expected.
   https://github.com/apache/avro/actions/runs/6266491283/job/17017596658?pr=2510#step:6:16


-- 
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 commented on pull request #2510: AVRO-3868: [Rust][CI] Check consistency between the doc comment in lib.rs and README.md

Posted by "martin-g (via GitHub)" <gi...@apache.org>.
martin-g commented on PR #2510:
URL: https://github.com/apache/avro/pull/2510#issuecomment-1731054502

   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 commented on pull request #2510: AVRO-3868: [Rust][CI] Check consistency between the doc comment in lib.rs and README.md

Posted by "martin-g (via GitHub)" <gi...@apache.org>.
martin-g commented on PR #2510:
URL: https://github.com/apache/avro/pull/2510#issuecomment-1729271838

   > Making CI slower is indeed not good so how about caching `cargo-rdme`?
   
   That would be OK!


-- 
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