Skip to content
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.

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

[DOC] ColumnView not clickable link in doxygen #11295

Closed
dagardner-nv opened this issue Jul 18, 2022 · 4 comments
Closed

[DOC] ColumnView not clickable link in doxygen #11295

dagardner-nv opened this issue Jul 18, 2022 · 4 comments
Assignees
Labels
doc Documentation

Comments

@dagardner-nv
Copy link
Contributor

Report incorrect documentation

Location of incorrect documentation
https://docs.rapids.ai/api/libcudf/stable/classcudf_1_1detail_1_1table__view__base.html#details

Describe the problems or issues found in the documentation
The return type of the column method ColumnView should be a link to the definition of the column_view class.

I believe the issue is that in table_view_base ColumnView is in the template type.
While in table_view its a type alias and most of the methods are inherited from the base.

Steps taken to verify documentation is incorrect
Not sure if there is a way in Doxygen to fix this.

@dagardner-nv dagardner-nv added Needs Triage Need team to review and classify doc Documentation labels Jul 18, 2022
@davidwendt
Copy link
Contributor

The return type of the column method ColumnView should be a link to the definition of the column_view class.

The ColumnView here is a template type name that can represent either column_view or mutable_column_view and so making it link to just column_view would be incorrect and it is not possible to link to both.

@dagardner-nv
Copy link
Contributor Author

Ahh OK that makes sense, any chance it could be a link to column_view_base then?
If not, OK to close.

@davidwendt
Copy link
Contributor

Ahh OK that makes sense, any chance it could be a link to column_view_base then?

I don't see how doxygen would do that with the given source code. Also, I don't agree that this should link to column_view_base since ColumnView would not be strictly that type.

The doxygen here does look poorly formed so I'm inclined to clean it up and add a comment that ColumnView is expected to be either a column_view or a mutable_column_view.

@davidwendt davidwendt self-assigned this Jul 26, 2022
@davidwendt davidwendt removed the Needs Triage Need team to review and classify label Jul 26, 2022
rapids-bot bot pushed a commit that referenced this issue Jul 28, 2022
@davidwendt
Copy link
Contributor

Closed by #11340

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation
Projects
None yet
Development

No branches or pull requests

2 participants