Comments (6)
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.
@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.
@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.
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.
Sounds good!
from tonic.
This can be closed now that we've removed examples from the readme, thanks for all the help!
from tonic.
Related Issues (20)
- Introduce a build option to not add `#[async_trait]` on generated service.
- BrokenPipe Error Using TLS With Root Certificate
- Received Status.source = None when server sends Status.source = Some
- Use a `Sink` argument instead of returning a `Stream` for response streaming
- Limit of 4M on outgoing messages HOT 3
- Malformed response for non `Ok` statuses when using `web_tonic` on the server.
- Dynamically named services
- Bump hyper / http / http-body to 1.x version HOT 2
- Integration of flatbuffers
- gRPC-web CORS issue HOT 1
- Add a way to test/inspect server and router build/configuration
- GOAWAY message leads to other Clients/Channels being unresponsive
- `tonic-reflection` is still using deprecated file descriptor set reflection_v1alpha1 HOT 1
- tonic-build: Codegen generates a name collision after auto-capitalization is applied, resulting in cargo build errors HOT 1
- `tonic-health`: add `NOT_SERVING` override for all registered services
- Idiomatic import paths
- IPv6 endpoint passed through the URL will crash
- Async Interceptor support HOT 2
- How to create channel without tls when tls feature flag is enabled HOT 1
- Response::new does not send grpc-status code correctly HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from tonic.