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

Method args are not included in generated markdown #37

Open
christi-stripe opened this issue May 26, 2023 · 1 comment
Open

Method args are not included in generated markdown #37

christi-stripe opened this issue May 26, 2023 · 1 comment
Labels
bug Something isn't working good first issue Good for newcomers help wanted Extra attention is needed

Comments

@christi-stripe
Copy link

In the Bird example you have # :args: direction, velocity but the generated markdown does not include these args.

Screenshot 2023-05-26 at 4 50 00 PM Screenshot 2023-05-26 at 4 49 50 PM

I would have expected :args: to carry through to the markdown. I also would have expected a way to add a comment to those so you can describe them and their types.

@skatkov skatkov added bug Something isn't working help wanted Extra attention is needed good first issue Good for newcomers labels May 28, 2023
@skatkov
Copy link
Owner

skatkov commented May 28, 2023

Thanks for reporting. Definitely an issue that should be resolved.

I'm currently building another project in my spare time. If you want to take a stab at it, you're very welcome. Otherwise, I can take a look at it, but after some time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants