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

Document argument mapping #50

Merged
merged 2 commits into from
Jan 26, 2020
Merged

Document argument mapping #50

merged 2 commits into from
Jan 26, 2020

Conversation

LordYuuma
Copy link
Collaborator

The examples and the documentation of functions and methods don't line up due to our renaming and in case of the self argument automatic name generation. Just like plain old GTKDoc, we should create a table per function, in which the arguments and their meaning are listed – especially the relation to C arguments.

@LordYuuma LordYuuma added the enhancement New feature or request label Sep 2, 2019
@LordYuuma LordYuuma self-assigned this Sep 2, 2019
@spk121
Copy link
Owner

spk121 commented Jan 25, 2020

Is this patchset still something that should be incorporated?

@LordYuuma
Copy link
Collaborator Author

I don't think ArgMap has changed since I've implemented this, so I'd say "yes" in the sense that it should still be working. As far as utility is concerned, I think something like this is necessary if we want to rely on generated documentation at all, as we don't perform any transformation on the docstrings. Without it, the Scheme arguments are given as some-parameter whereas the documentation refers to some_parameter with potentially n_some_parameter as a count that we don't expose to the Scheme side. Having the documentation of the individual arguments, which sometimes exists, in there is also a nice bonus.

@spk121 spk121 merged commit 2c379aa into master Jan 26, 2020
@spk121 spk121 deleted the dev-document branch February 20, 2022 03:43
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants