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(neon): document public api #745

Closed
wants to merge 1 commit into from
Closed

docs(neon): document public api #745

wants to merge 1 commit into from

Conversation

Leptopoda
Copy link
Member

@Leptopoda Leptopoda commented Sep 8, 2023

tackles the code side of #692

This is just some initial work I did. I mainly wanted to document the public facing api and whatever we find odd should be opened in an issue. Ill work on this every now and then in the next weeks so we can have a decent documentation at launch.

@provokateurin If you have the time and want help feel free to add commits to the branch (and fix my typos. I think reviews are just an overhead here). We can later squash everything together into a nice big commit :)

@Leptopoda
Copy link
Member Author

I rebased it onto #840 and after it is merged I'll clean up the commit history.

As I also did minor cleanups to the interfaces of some classes I'll probably do one commit per class and only group them together where it makes sense.

@provokateurin
Copy link
Member

Should this still be in draft?

@Leptopoda
Copy link
Member Author

I pushed something wrong.
I'll push the right stuff and mark it as ready to review.

Signed-off-by: Nikolas Rimikis <leptopoda@users.noreply.github.com>
@Leptopoda Leptopoda deleted the doc/neon branch October 30, 2023 07:29
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.

None yet

2 participants