Coder Social home page Coder Social logo

Comments (4)

LucioFranco avatar LucioFranco commented on September 23, 2024

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

sezna avatar sezna commented on September 23, 2024

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.

LucioFranco avatar LucioFranco commented on September 23, 2024

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.

sezna avatar sezna commented on September 23, 2024

Hm, ok. I will wrap it for now and talk to the prost people about this. Thanks!

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.