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 #170

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft

Docs #170

wants to merge 6 commits into from

Conversation

mat-xc
Copy link
Collaborator

@mat-xc mat-xc commented Feb 11, 2024

Based on the work in #167, we can extract documentation for functions and function arguments.

TODO:

  • Add docstring to __init__() for classes
  • Fix wrapped functions
  • Fix symbol (signal and property tags) with same name of functions (Like Gtk.Widget.show, shows the documentation for the signal and not the function)
  • Add documentation for virtual functions (do_xxx)
  • Add documentation to properties

Closes #76

{'\n '.join([f'{s}: {arg_doc[s]}' for s in args])}

Returns:
{return_doc or ""}{'\n '.join([f'{ret_args[s]}: {arg_doc[s]}' for s in return_names])}
Copy link
Contributor

Choose a reason for hiding this comment

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

This appears to require Python ≥ 3.12, whereas pyproject.toml claims to support ≥ 3.7:

SyntaxError: f-string expression part cannot include a backslash

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.

Plans to include docstrings?
2 participants