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

Change API header titles and info #6397

Merged
merged 3 commits into from
Jan 29, 2024
Merged

Conversation

dimitraka
Copy link
Contributor

@dimitraka dimitraka commented Dec 7, 2023

The API documentation now includes the following information:

  1. title of the page includes the functions that are documented in each page
  2. the header file (along with its link) needed to be included is listed under the page title

For example, instead of the title:
hpx/parallel/algorithms/adjacent_find.hpp

The new title will be:
hpx::adjacent_find
followed by the include information:
Defined in header hpx/algorithm.hpp

Copy link

codacy-production bot commented Dec 7, 2023

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
-0.02%
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (c0d79c8) 201862 171892 85.15%
Head commit (1442a7c) 190688 (-11174) 162330 (-9562) 85.13% (-0.02%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#6397) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

You may notice some variations in coverage metrics with the latest Coverage engine update. For more details, visit the documentation

@hkaiser
Copy link
Member

hkaiser commented Jan 17, 2024

@dimitraka could you please resolve the conflicts intorduced by a recent merge to HPX master?

@dimitraka dimitraka force-pushed the doc_updates branch 2 times, most recently from edec39e to 0a4d12e Compare January 20, 2024 17:42
hkaiser
hkaiser previously approved these changes Jan 27, 2024
Copy link
Member

@hkaiser hkaiser left a comment

Choose a reason for hiding this comment

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

Thanks @dimitraka! Much appreciated! LGTM.

@hkaiser
Copy link
Member

hkaiser commented Jan 27, 2024

@dimitraka Would you mind having a look at the clang-format issues reported?

@hkaiser hkaiser merged commit eb08c33 into STEllAR-GROUP:master Jan 29, 2024
43 of 47 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants