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.

Sign up for GitHub

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

Jump to bottom

correct uses of :param name: and :return: in docstrings to generate API docs in MarkDown format #4129

Merged
merged 3 commits into from
Nov 27, 2022
Merged

correct uses of :param name: and :return: in docstrings to generate API docs in MarkDown format #4129

merged 3 commits into from
Nov 27, 2022

Conversation

branfosj
Copy link
Member

@branfosj branfosj commented Nov 27, 2022 •
edited
Loading

One of the markdown API document generators I am trying:

  • blows up on :param:
  • does not recognise :params ...
  • blows up on :param name description (missing : after the parameter name)
  • blows up on :return ...

@branfosj branfosj added this to the next release (4.7.0) milestone Nov 27, 2022
@branfosj branfosj changed the title use :param name: consistently in docstrings correct uses of :param name: and :return: in docstrings Nov 27, 2022
ocaisa
ocaisa previously approved these changes Nov 27, 2022
View reviewed changes
Copy link
Member

@ocaisa ocaisa left a comment

Choose a reason for hiding this comment

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

LGTM

@ocaisa ocaisa enabled auto-merge November 27, 2022 10:10
@branfosj branfosj mentioned this pull request Nov 27, 2022
Closed
ocaisa
ocaisa approved these changes Nov 27, 2022
View reviewed changes
Copy link
Member

@ocaisa ocaisa left a comment

Choose a reason for hiding this comment

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

Still LGTM

@ocaisa ocaisa merged commit 872df2b into easybuilders:develop Nov 27, 2022
@branfosj branfosj deleted the fix_param branch November 27, 2022 11:19
@boegel boegel added the bug fix label Dec 18, 2022
@boegel boegel changed the title correct uses of :param name: and :return: in docstrings correct uses of :param name: and :return: in docstrings to generate API docs in MarkDown format Jan 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ocaisa ocaisa ocaisa approved these changes

Assignees
No one assigned
Labels
bug fix documentation
Projects
None yet
Milestone
4.7.0
Development

Successfully merging this pull request may close these issues.
3 participants
@branfosj @ocaisa @boegel