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

Improve documentation and landing page #342

Closed
timfel opened this issue Aug 23, 2022 · 2 comments
Closed

Improve documentation and landing page #342

timfel opened this issue Aug 23, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@timfel
Copy link
Contributor

timfel commented Aug 23, 2022

From IRC:

mkoubaa> actually, Mark did talk to HPy first. See here: #323
mkoubaa> I think the mental model of "the API is mostly a struct of pointers to functions" is hard to grasp initially. However, this is exactly what a vtable looks like and most people can follow that. I think HPy can do a better job of explaining why it made that choice for HPyContext
mkoubaa> The HPy github repo does a poor job of saying "this is the definition of the HPyContext in this header file", instead relying on codegen. I don't fully understand why we don't just have a hand-crafted hpy.h that defines the API and then implementation-specific header files for universal, cpython, etc. But I also haven't made a big effort to understand the codegen system

Also Mark seemed to have a hard time finding documentation: markshannon/New-C-API-for-Python#1 (comment)

@timfel timfel added this to the Version 0.9 milestone Nov 1, 2022
@fangerer
Copy link
Contributor

fangerer commented Dec 19, 2022

I think this issue can serve as a meta issue for all documentation-related issues in the 0.9 milestone:

@fangerer
Copy link
Contributor

I've also updated the landing page (i.e. hpyproject.org) but we plan to do further improvements (e.g. adding some nice benchmarks ...).

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

No branches or pull requests

2 participants