Comments (4)
@sezna Hi! So quick and easy fix is to annotate the overall module with #[allow(missing_docs]
.
Do you by chance know which module is causing the error? is it the client/server mod?
from tonic.
I haven't actually used the client or the server yet. Right now I'm just generating structs from .proto files. When I run codegen like this:
tonic_build::configure().compile(&["foo.proto"], &["../protocol"]).unwrap()
it generates code like this:
#[allow(non_snake_case, unused_attributes)]
mod foo_MESSAGE {
extern crate bytes as _bytes;
extern crate prost as _prost;
use super::*;
impl _prost::Message for Foo {
// ... lots of methods
}
}
// <-- there is no way for me to put a docstring here
pub mod foo { // missing doc warning happens here
// ... lots of methods and things
}
I could wrap the import macro with another module and allow missing docs on it for now, but that doesn't seem optimal, because I would like to have doc enforcement on all of my protobuf fields as I currently do.
from tonic.
This sounds like something prost is doing, we add doc comments to all the mods we generate and we just append that to the file that prost generates.
As for wrapping it in a mod I generally tend to do that anyways.
from tonic.
Hm, ok. I will wrap it for now and talk to the prost people about this. Thanks!
from tonic.
Related Issues (20)
- Naming collisions with std::marker::Sync/Send HOT 1
- How to make tonic support tls HOT 4
- nit: inconsistent use of crate::Error vs Error in single transport src file
- calling grpc server hosted on cloud run with https fails with transport error HOT 2
- version 0.12.1 causes ClientTlsConfig to explode with invalid CryptoProvider HOT 2
- Configuring Timeout for Graceful Shutdown HOT 1
- How to get grpc-status in Layer? HOT 1
- Make the TimeoutExpired a public tonic type rather than a transport type
- tonic_build clone server
- long headers from the server hang tonic HOT 5
- Non-Anonymous Authentication
- The trait `Message` is not implemented HOT 1
- Remove trait bound on generated server struct
- NamedService makes it impossible to wrap individual services with non-intercept layers HOT 2
- After tonic is updated from 0.8.3 to 0.11.0 in the csi driver, an error message "PROTOCOL_ERROR" is displayed when kubelet calls the get_info interface.
- Share tonic server port with other http routes HOT 3
- Protobuf bytes field incorrectly parsed as String when generating gRPC code with tonic_build HOT 1
- tonic-build can no longer build code with rust < 1.77.0, due to newer build-script syntax HOT 1
- Tonic v0.13 fails to build what worked on v0.12 HOT 1
- The tonic server process exit unexpected when the client get a wrong tls config HOT 3
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.