Coder Social home page Coder Social logo

Add readme rustdoc tests to CI about tonic HOT 6 CLOSED

hyperium avatar hyperium commented on June 21, 2024
Add readme rustdoc tests to CI

from tonic.

Comments (6)

senden9 avatar senden9 commented on June 21, 2024

Alternative Idea: Use cargo-readme to auto-generate / check the readme.
This way the README file would be in sync with the tonic docs.rs page (modulo some header/footer stuff). Code examples would be tested automatically via cargo test because the live in a .rs file.

Bonus: You have the same nice "introduction information" no mater if new users land on the docs.rs page or this GitHub repository.

from tonic.

LucioFranco avatar LucioFranco commented on June 21, 2024

@senden9 the issue with that is we can't have fully-fledged examples in the main readme because it requires codegen and hooking into the rustdocs build.rs. I am considering just dropping examples from the readme since this will be hard and just point people to the examples crate.

from tonic.

mattsre avatar mattsre commented on June 21, 2024

@LucioFranco Is there currently any testing around the examples to ensure they are working? If not, is this something we should think about writing and adding into the CI?

from tonic.

LucioFranco avatar LucioFranco commented on June 21, 2024

So I am going to remove all examples from the readme. We will instead point to the examples crate which is checked via CI already. All doc examples are also checked via CI and cargo test.

from tonic.

mattsre avatar mattsre commented on June 21, 2024

Sounds good!

from tonic.

LucioFranco avatar LucioFranco commented on June 21, 2024

This can be closed now that we've removed examples from the readme, thanks for all the help!

from tonic.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.