ByteBaker commented on issue #37:
URL: https://github.com/apache/arrow-rs/issues/37#issuecomment-2363362467
I have a question.
There are instances when I see a utility function, called nowhere else but
the file it's in, has `pub` visibility. This also generates a no-docs' warning.
Making the function private (coz that's what it appears to be) removes the
warning.
Should I do so? Or make it private but add the docs still; or just add the
docs? For instance look at this:
```rust
/// Create a visual representation of columns
pub fn pretty_format_columns(
col_name: &str,
results: &[ArrayRef],
) -> Result<impl Display, ArrowError> {
let options = FormatOptions::default().with_display_error(true);
pretty_format_columns_with_options(col_name, results, &options)
}
pub fn pretty_format_columns_with_options(
col_name: &str,
results: &[ArrayRef],
options: &FormatOptions,
) -> Result<impl Display, ArrowError> {
create_column(col_name, results, options)
}
```
This is the only call for `pretty_format_columns_with_options`. Though I
have my suspicions against doing so because it's exposed in the API and might
be an issue for end-users. What's your thoughts?
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
