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: Clear warnings from roxygen build #3004

Merged

Conversation

david-cortes-intel
Copy link
Contributor

@david-cortes-intel david-cortes-intel commented Dec 3, 2024

Description

This PR should clear some warnings that are observed in the CI job that builds the roxygen docs:

/home/vsts/work/1/s/cpp/oneapi/dal/graph/service_functions.hpp:90: warning: argument 'graph' of command @param is not found in the argument list of oneapi::dal::preview::get_edge_value(const Graph &g, vertex_type< Graph > u, vertex_type< Graph > v) -> const edge_user_value_type< Graph > &
/home/vsts/work/1/s/cpp/oneapi/dal/graph/service_functions.hpp:158: warning: The following parameter of oneapi::dal::preview::get_edge_value(const Graph &g, vertex_type< Graph > u, vertex_type< Graph > v) -> const edge_user_value_type< Graph > & is not documented:
  parameter 'g'
/home/vsts/work/1/s/cpp/oneapi/dal/algo/jaccard/common.hpp:148: warning: argument 'in' of command @param is not found in the argument list of caching_builder::operator()(std::int64_t block_max_size)
/home/vsts/work/1/s/cpp/oneapi/dal/algo/jaccard/common.hpp:148: warning: argument 'out' of command @param is not found in the argument list of caching_builder::operator()(std::int64_t block_max_size)
/home/vsts/work/1/s/cpp/oneapi/dal/algo/jaccard/vertex_similarity_types.hpp:40: warning: argument 'graph' of command @param is not found in the argument list of vertex_similarity_input< Graph, Task >::vertex_similarity_input(const Graph &g, caching_builder &builder)
/home/vsts/work/1/s/cpp/oneapi/dal/algo/jaccard/vertex_similarity_types.hpp:40: warning: argument 'in' of command @param is not found in the argument list of vertex_similarity_input< Graph, Task >::vertex_similarity_input(const Graph &g, caching_builder &builder)
/home/vsts/work/1/s/cpp/oneapi/dal/algo/jaccard/vertex_similarity_types.hpp:40: warning: argument 'out' of command @param is not found in the argument list of vertex_similarity_input< Graph, Task >::vertex_similarity_input(const Graph &g, caching_builder &builder)
/home/vsts/work/1/s/cpp/oneapi/dal/algo/jaccard/vertex_similarity_types.hpp:44: warning: The following parameters of oneapi::dal::preview::jaccard::vertex_similarity_input::vertex_similarity_input(const Graph &g, caching_builder &builder) are not documented:
  parameter 'g'
  parameter 'builder'
/home/vsts/work/1/s/cpp/oneapi/dal/spmd/communicator.hpp:254: warning: argument 'send_buf' of command @param is not found in the argument list of communicator< MemoryAccessKind >::allgather(const array< D > &send, const array< D > &recv) const
/home/vsts/work/1/s/cpp/oneapi/dal/spmd/communicator.hpp:254: warning: argument 'send_count' of command @param is not found in the argument list of communicator< MemoryAccessKind >::allgather(const array< D > &send, const array< D > &recv) const
/home/vsts/work/1/s/cpp/oneapi/dal/spmd/communicator.hpp:254: warning: argument 'recv_buf' of command @param is not found in the argument list of communicator< MemoryAccessKind >::allgather(const array< D > &send, const array< D > &recv) const
/home/vsts/work/1/s/cpp/oneapi/dal/spmd/communicator.hpp:254: warning: argument 'recv_count' of command @param is not found in the argument list of communicator< MemoryAccessKind >::allgather(const array< D > &send, const array< D > &recv) const
/home/vsts/work/1/s/cpp/oneapi/dal/spmd/communicator.hpp:254: warning: argument 'dtype' of command @param is not found in the argument list of communicator< MemoryAccessKind >::allgather(const array< D > &send, const array< D > &recv) const
/home/vsts/work/1/s/cpp/oneapi/dal/spmd/communicator.hpp:264: warning: The following parameters of oneapi::dal::preview::spmd::v1::communicator::allgather(const array< D > &send, const array< D > &recv) const are not documented:
  parameter 'send'
  parameter 'recv'
/home/vsts/work/1/

PR should start as a draft, then move to ready for review state after CI is passed and all applicable checkboxes are closed.
This approach ensures that reviewers don't spend extra time asking for regular requirements.

You can remove a checkbox as not applicable only if it doesn't relate to this PR in any way.
For example, PR with docs update doesn't require checkboxes for performance while PR with any change in actual code should have checkboxes and justify how this code change is expected to affect performance (or justification should be self-evident).

Checklist to comply with before moving PR from draft:

PR completeness and readability

  • I have reviewed my changes thoroughly before submitting this pull request.
  • Git commit message contains an appropriate signed-off-by string (see CONTRIBUTING.md for details).
  • I have added a respective label(s) to PR if I have a permission for that.
  • I have resolved any merge conflicts that might occur with the base branch.

Testing

  • All CI jobs are green or I have provided justification why they aren't.

Performance

Not applicable.

@david-cortes-intel david-cortes-intel marked this pull request as ready for review December 9, 2024 08:39
@david-cortes-intel
Copy link
Contributor Author

CI failures in OpenBLAS are unrelated to this PR.

Copy link
Contributor

@Vika-F Vika-F left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving, but let's preserve the alignment in the comments.

cpp/oneapi/dal/algo/jaccard/vertex_similarity_types.hpp Outdated Show resolved Hide resolved
cpp/oneapi/dal/graph/service_functions.hpp Outdated Show resolved Hide resolved
david-cortes-intel and others added 2 commits December 11, 2024 14:02
Co-authored-by: Victoriya Fedotova <viktoria.nn@gmail.com>
Co-authored-by: Victoriya Fedotova <viktoria.nn@gmail.com>
@david-cortes-intel david-cortes-intel merged commit 11f999e into uxlfoundation:main Dec 11, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issue/PR related to oneDAL docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants