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

Extension is not documented #3

Closed
YuriSizov opened this issue Apr 8, 2024 · 1 comment
Closed

Extension is not documented #3

YuriSizov opened this issue Apr 8, 2024 · 1 comment
Labels
documentation enhancement A new feature or feature improvement
Milestone

Comments

@YuriSizov
Copy link
Owner

Right now the GDSiON extension provides only the auto-generated documentation, containing method and property names and types, but no functional description or guidance.

GDExtensions may not support XML documentation yet, so in the meantime any other means to describe the functionality should be explored, including Markdown files and GitHub wiki.

The original SiON project has quite a lot useful comments with descriptions and examples, which can be lifted as a starting point. Note that some liberties were taken when porting certain aspects of the original implementation, so care must be applied when borrowing descriptions. I also noticed a few outdated comments/errors/copy-paste mistakes while working on the codebase.

@YuriSizov YuriSizov added documentation enhancement A new feature or feature improvement labels Apr 8, 2024
@YuriSizov
Copy link
Owner Author

YuriSizov commented Apr 9, 2024

Some points of reference:

@YuriSizov YuriSizov added this to the 0.7 milestone Jun 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement A new feature or feature improvement
Projects
None yet
Development

No branches or pull requests

1 participant