[GitHub] [arrow-rs] alamb commented on issue #37: Enable "#![warn(missing_docs)]"

[GitBox <gi...@apache.org>]

alamb commented on issue #37:
URL: https://github.com/apache/arrow-rs/issues/37#issuecomment-826756842


   Comment from Owen Nelson(theomn) @ 2019-03-10T01:53:37.792+0000:
   <pre>Adding the attribute to arrow, datafusion, and parquet yields around 183 errors currently. I may take a little effort to cover the gap that exists right now.
   
    As a newcomer to the project, I'm looking for ways to explore the codebase and I'd welcome the chance to take a stab at this, however being so unfamiliar with the internals I may need to refer to the docs on one of the other lang's implementations. I may need to refer to the other implementations anyway just to keep the phrasing consistent. It could take some time.
   
   Any objections to me digging into this?
   
   Additionally, would we prefer to set missing docs to warnings rather than errors now that CI will treat warnings as errors as of ARROW-2409?</pre>
   
   Comment from Paddy Horan(paddyhoran) @ 2019-03-11T02:08:31.146+0000:
   <pre>Hey,
   
   Feel free to dig into this.  I opened the issue as eventually I would like us to have this enabled.  But my plan was always to come back and open smaller documentation related issues that would build up to adding this feature.
   
   One of the first PR's I did was to update the docs of the `datatypes` module so feel free to take it module by module as you learn the code base.
   
   +1 for warnings instead of errors now that you tackled ARROW-2409.
   
   Feel free to reach out if you have questions.</pre>


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org