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][C++]: Refine documentation comments #203

Closed
1 task done
Thespica opened this issue Jul 14, 2023 · 2 comments · Fixed by #204
Closed
1 task done

[Doc][C++]: Refine documentation comments #203

Thespica opened this issue Jul 14, 2023 · 2 comments · Fixed by #204

Comments

@Thespica
Copy link
Contributor

Is there an existing issue for this?

  • I have searched the existing issues

Current Behavior

In documentation comments, @param name is not same as real parameter name.
Here are some differences I had discovered, maybe there are others I haven't discovered :

https://github.com/alibaba/GraphAr/blob/75dfb4234c7bb1aaaf2d408a4e3e0aed92a127a6/cpp/include/gar/graph_info.h#L1086
https://github.com/alibaba/GraphAr/blob/75dfb4234c7bb1aaaf2d408a4e3e0aed92a127a6/cpp/include/gar/graph_info.h#L1260

Expected Behavior

@param name is same as real parameter name.

Minimal Reproducible Example

https://github.com/alibaba/GraphAr/blob/75dfb4234c7bb1aaaf2d408a4e3e0aed92a127a6/cpp/include/gar/graph_info.h#L1257
https://github.com/alibaba/GraphAr/blob/75dfb4234c7bb1aaaf2d408a4e3e0aed92a127a6/cpp/include/gar/graph_info.h#L1260

Environment

  • Operating system:
  • GraphAr version:

Link to GraphAr Logs

No response

Further Information

No response

@Thespica
Copy link
Contributor Author

We can keep this issue for a while so that we can point it out when we found any documentation comments problems.

replace is is by is
https://github.com/alibaba/GraphAr/blob/75dfb4234c7bb1aaaf2d408a4e3e0aed92a127a6/cpp/include/gar/graph_info.h#L1056

@Thespica Thespica changed the title [Bug]: @param name is not same as real parameter name [Doc][C++]: Refine documentation comments Jul 15, 2023
@sighingnow
Copy link
Contributor

sighingnow commented Jul 15, 2023

Hi @Thespica,

Thanks for raising these issues. Would you mind submitting a pull request for a quick fix?

Thanks!

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

Successfully merging a pull request may close this issue.

2 participants