Skip to content

InfoDev review of API section #1659

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

Conversation

bdmoore1
Copy link
Contributor

@bdmoore1 bdmoore1 commented May 1, 2024

I reviewed the API section. There were some terms that did not match up so I changed them. For example C-API is not how Python uses the C API name so I removed the - .

I will submit separate PRs for these sections: beginners_guides, contributor_guides, and user_guides.

  • Have you provided a meaningful PR description?
  • Have you added a test, reproducer or referred to an issue with a reproducer?
  • Have you tested your changes locally for CPU and GPU devices?
  • Have you made sure that new changes do not introduce compiler warnings?
  • Have you checked performance impact of proposed changes?
  • If this PR is a work in progress, are you opening the PR as a draft?

I reviewed the API section. There were some terms that did not match up so I changed them. For example C-API is not how Python uses the C API name so I removed the - .
@bdmoore1
Copy link
Contributor Author

bdmoore1 commented May 1, 2024

@ndgrigorian @xaleryb I do not have the ability to add reviewers. Please add appropriate reviewers to this PR.

@ndgrigorian
Copy link
Collaborator

@ndgrigorian @xaleryb I do not have the ability to add reviewers. Please add appropriate reviewers to this PR.

I've added myself and @oleksandr-pavlyk

@coveralls
Copy link
Collaborator

coveralls commented May 2, 2024

Coverage Status

coverage: 87.892%. remained the same
when pulling 3deca07 on bdmoore1:bdmoore1-api-reference-doc-review
into 6ae9f3d on IntelPython:master.

@oleksandr-pavlyk oleksandr-pavlyk self-requested a review May 3, 2024 02:50
Copy link
Contributor

@oleksandr-pavlyk oleksandr-pavlyk left a comment

Choose a reason for hiding this comment

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

Thank you @bdmoore1 for the changes! They look good to me now.

As a side note, should we be using Python/C API as in https://docs.python.org/3/c-api/index.html, or Python C API as in the document?

If the change is needed, let's do it in a separate PR.

@bdmoore1
Copy link
Contributor Author

bdmoore1 commented May 3, 2024

@oleksandr-pavlyk yes we should standardize the name Python/C API. I will create a DOC Jira and target 2025.0 to complete that task.

Copy link
Collaborator

@ndgrigorian ndgrigorian left a comment

Choose a reason for hiding this comment

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

LGTM

@oleksandr-pavlyk oleksandr-pavlyk merged commit 0cb2181 into IntelPython:master May 4, 2024
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.

4 participants