Skip to content

docs: fix typos in nanoarrow.h docstrings #837

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paleolimbot merged 1 commit into from
Dec 31, 2025
Merged

docs: fix typos in nanoarrow.h docstrings #837

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions src/nanoarrow/nanoarrow.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ static inline ArrowErrorCode ArrowArrayStreamGetSchema(
struct ArrowArrayStream* array_stream, struct ArrowSchema* out,
struct ArrowError* error);

/// \brief Call the get_schema callback of an ArrowArrayStream
/// \brief Call the get_next callback of an ArrowArrayStream
/// \ingroup nanoarrow-arrow-cdata
///
/// Unlike the get_next callback, this wrapper checks the return code
Expand All @@ -245,12 +245,13 @@ static inline ArrowErrorCode ArrowArrayStreamGetNext(
struct ArrowArrayStream* array_stream, struct ArrowArray* out,
struct ArrowError* error);

/// \brief Call the get_next callback of an ArrowArrayStream
/// \brief Call the get_last_error callback of an ArrowArrayStream
/// \ingroup nanoarrow-arrow-cdata
///
/// Unlike the get_next callback, this function never returns NULL (i.e., its
/// result is safe to use in printf-style error formatters). Null values from the
/// original callback are reported as "<get_last_error() returned NULL>".
/// Unlike the get_last_error callback, this function never returns NULL (i.e.,
/// its result is safe to use in printf-style error formatters). Null values
/// from the original callback are reported as
/// "<get_last_error() returned NULL>".
static inline const char* ArrowArrayStreamGetLastError(
struct ArrowArrayStream* array_stream);

Expand Down
Loading