GH-46818: [Docs][C++] Add missing method description in type.h #46819
Conversation
|
|
|
@github-actions crossbow submit preview-docs |
|
Revision: f0e9bf8 Submitted crossbow builds: ursacomputing/crossbow @ actions-94ac5ab264
|
|
I wrote method description as a draft. Please feel free comments(modify) if you feel this PR useful.
|
There was a problem hiding this comment.
Thanks for taking a look at this @hiroyuki-sato ! I posted a few comments, but the general theme is that you should take some time writing some docstrings that are actually useful and informative.
cpp/src/arrow/type.h
Outdated
| @@ -1337,20 +1339,25 @@ class ARROW_EXPORT MapType : public ListType { | |||
|
|
|||
| explicit MapType(std::shared_ptr<Field> value_field, bool keys_sorted = false); | |||
|
|
|||
| // Validating constructor | |||
| /// Validating constructor | |||
There was a problem hiding this comment.
Please let's make this a real informative docstring too.
|
@zanmato1984 In case you want to chime in. |
github-actions
bot
added
awaiting committer review
|
@pitrou Thanks. I'll try to write useful description. Please review later agin. |
Co-authored-by: Antoine Pitrou <[email protected]>
Co-authored-by: Antoine Pitrou <[email protected]>
|
@github-actions crossbow submit preview-docs |
|
Revision: 6604ac8 Submitted crossbow builds: ursacomputing/crossbow @ actions-8a892a3aeb
|
|
I added http://crossbow.voltrondata.com/pr_docs/46819/cpp/api/datatype.html#classarrow_1_1_map_type I will continue working.
It will take a time because I don't know much the API usage. (That's why I needed the document 😄 ) |
Rationale for this change
This is the sub issue #46808
Since EXTRACT_ALL is set YES in Doxygen, I expect that methods without comments will also be included in the API Doc, but some methods are not documented.
For example
FixedSizeListType::list_sizeWhat changes are included in this PR?
Add missing method description in the
type.hfileAre these changes tested?
Yes.
Are there any user-facing changes?
No.
type.h#46818