Coder Social home page Coder Social logo

prost-doc's Introduction

This shows a simple example of what I believe to be a bug with the documentation for the prost generated output for the enum type.

The attribute #![warn(missing_docs)] is set before including the generated protobufs.

All the fields in the source test.proto file are documented.

With the missing_docs lint enabled cargo build gives this result:

photon:~/src/prost-doc$ cargo build
   Compiling prost-doc v0.1.0 (/home/curt/src/prost-doc)
warning: missing documentation for an associated function
  --> /home/curt/src/prost-doc/target/debug/build/prost-doc-890d2974c9ae4c69/out/test.rs:11:32
   |
11 |     #[derive(Clone, PartialEq, ::prost::Oneof)]
   |                                ^^^^^^^^^^^^^^
   |
note: the lint level is defined here
  --> src/lib.rs:3:9
   |
3  | #![warn(missing_docs)]
   |         ^^^^^^^^^^^^
   = note: this warning originates in a derive macro (in Nightly builds, run with -Z macro-backtrace for more info)

prost-doc's People

Contributors

cbrune avatar

Watchers

 avatar

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.