Support doc comments on function parameters#1353
Open
azzsal wants to merge 1 commit intoocaml:masterfrom
Open
Conversation
Collaborator
|
This looks a very good start! So, currently I believe you are "adding" the docstrings attached to arguments, to the docstring attached to the function: will be turned into: This is close to what we want! We want to embed them inside However, as you can see, we need parameter names. One first step would be to enable this only for labelled arguments: should be turned into: Let me know if something's unclear or if you need more guidance on how to do that! The other potential improvements are:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This should resolve #927.
The doc comments for function parameters are collected and stored with the docs for any value description.