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

Library needs more documentation #49

Open
Filipp-Druan opened this issue Nov 15, 2023 · 1 comment
Open

Library needs more documentation #49

Filipp-Druan opened this issue Nov 15, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@Filipp-Druan
Copy link

Hello!
I have high hopes for this library. I hope it will be a serious, thorough, long-term project.
Every serious library needs serious documentation. So far it's pretty bad.
Please write docstrings at least for the macros you write. Please!
You can use these tools:
https://github.com/Shinmera/staple
https://github.com/Shinmera/documentation-utils
If need be, I'm willing to put the documentation in a nice way, I'd be very happy to do so. Just please write a description of macros, please.

@bohonghuang bohonghuang added the documentation Improvements or additions to documentation label Nov 16, 2023
@bohonghuang
Copy link
Owner

bohonghuang commented Nov 16, 2023

I will add documentation for manually written APIs in cl-gtk4, but it's important to note that I cannot generate documentation for those dynamically generated GTK APIs because the GObject Typelib does not include documentation-related information.

bohonghuang added a commit that referenced this issue Nov 16, 2023
bohonghuang added a commit that referenced this issue Apr 18, 2024
bohonghuang added a commit that referenced this issue Apr 18, 2024
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