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

[docs] Printing C API html docs #1006

Merged
merged 2 commits into from
Feb 2, 2024

Conversation

PatKamin
Copy link
Contributor

@PatKamin PatKamin commented Oct 27, 2023

Generate HTML documentation for printing C API.
preview

Copy link
Contributor

@pbalcer pbalcer left a comment

Choose a reason for hiding this comment

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

how does it look like generated?

@PatKamin
Copy link
Contributor Author

how does it look like generated?

You can see it here.

@PatKamin PatKamin marked this pull request as ready for review November 2, 2023 14:23
@PatKamin PatKamin marked this pull request as draft November 6, 2023 14:47
@PatKamin PatKamin marked this pull request as ready for review November 7, 2023 09:17
@PatKamin PatKamin marked this pull request as draft November 20, 2023 11:58
@PatKamin
Copy link
Contributor Author

Converted to draft to make sure that the #930 is merged first.

@pbalcer pbalcer added the ready to merge Added to PR's which are ready to merge label Dec 11, 2023
@pbalcer
Copy link
Contributor

pbalcer commented Dec 11, 2023

please rebase.

@pbalcer pbalcer removed the ready to merge Added to PR's which are ready to merge label Dec 11, 2023
@PatKamin
Copy link
Contributor Author

please rebase.

Done

@codecov-commenter
Copy link

codecov-commenter commented Dec 11, 2023

Codecov Report

Attention: 1169 lines in your changes are missing coverage. Please review.

Comparison is base (95f9092) 15.73% compared to head (4e50fe6) 15.46%.

Files Patch % Lines
source/loader/ur_print.cpp 3.94% 1169 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1006      +/-   ##
==========================================
- Coverage   15.73%   15.46%   -0.27%     
==========================================
  Files         223      226       +3     
  Lines       31466    32711    +1245     
  Branches     3556     3561       +5     
==========================================
+ Hits         4952     5060     +108     
- Misses      26463    27600    +1137     
  Partials       51       51              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@PatKamin PatKamin changed the title Printing C API html docs [docs] Printing C API html docs Jan 26, 2024
Print the exact location of errors in mako templates by printing a full
backtrace instead of a stripped output without the file:line information
- add a helper script for generating Printing API HTML documentation and
  source files,
- remove wrong comment on returning an error when the 'buffer' parameter
is NULL,
- remove redundant check for the 'params' parameter.
@PatKamin PatKamin marked this pull request as ready for review January 29, 2024 15:33
@PatKamin PatKamin requested a review from a team as a code owner January 29, 2024 15:33
@pbalcer pbalcer merged commit 8c604b0 into oneapi-src:main Feb 2, 2024
48 checks passed
@PatKamin PatKamin deleted the printing-capi-html-docs branch June 26, 2024 10:07
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 this pull request may close these issues.

6 participants