You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "stephen-a-stc (via GitHub)" <gi...@apache.org> on 2024/11/06 15:22:05 UTC

[I] Documentation: C API reference missing information [arrow-nanoarrow]

stephen-a-stc opened a new issue, #676:
URL: https://github.com/apache/arrow-nanoarrow/issues/676

   This issue refers to the documentation hosted here: https://arrow.apache.org/nanoarrow/0.6.0/reference/c.html#arrow-c-data-interface
   
   The C API reference documentation for version `0.6.0` appears to be missing some content.  Perhaps some of this was removed intentionally, but I believe much of the missing content is unintentional, particularly for the "Error handling" and "Arrow C Data Interface" sections.  
   
   Here is a list of some items that were present in the [`0.5.0` documentation](https://arrow.apache.org/nanoarrow/0.5.0/reference/c.html) but are missing from [`0.6.0` documentation](https://arrow.apache.org/nanoarrow/0.6.0/reference/c.html).  
   
   - Creating arrays > `ArrowValidationLevel`
   - Reading arrays > `ArrowBufferType`
   - Owning, growable buffers
     - `ArrowBufferAllocator`
     - `ArrowBuffer`
   - Bitmap utilities
     - `ArrowBitmap`
   - Error handling
     - `ArrowErrorCode`
     - `ArrowErrorInit()`
     - `ArrowErrorMessage()`
     - `ArrowErrorSetString()`
     - `ArrowError`
   - Utility Data Structures
     - Significant differences in available content
   - Arrow C Data Interface
     - the entire section is missing, an error message appears
   
   > **Arrow C Data Interface *[warning message](https://arrow.apache.org/nanoarrow/0.6.0/reference/c.html#arrow-c-data-interface)***
   > *doxygengroup: Cannot find group “nanoarrow-arrow-cdata” in doxygen xml output for project “nanoarrow_c” from directory: ../../src/apidoc/xml*


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

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org.apache.org

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


Re: [I] Documentation: C API reference missing information [arrow-nanoarrow]

Posted by "paleolimbot (via GitHub)" <gi...@apache.org>.
paleolimbot commented on issue #676:
URL: https://github.com/apache/arrow-nanoarrow/issues/676#issuecomment-2460073282

   Thank you for reporting! That was definitely unintentional. We shuffled some of the files around and the one containing the definitions for those (src/nanoarrow/common/types_inline.h) is probably not getting parsed by Doxygen (because we have to update the configuration or because doxygen is confused by something in the header).


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

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

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


Re: [I] Documentation: C API reference missing information [arrow-nanoarrow]

Posted by "paleolimbot (via GitHub)" <gi...@apache.org>.
paleolimbot closed issue #676: Documentation: C API reference missing information
URL: https://github.com/apache/arrow-nanoarrow/issues/676


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

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

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