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

Improvements to the location of the return type #300

Merged
merged 6 commits into from Jan 18, 2023
Merged

Improvements to the location of the return type #300

merged 6 commits into from Jan 18, 2023

Commits on Jan 18, 2023

  1. Improvements to the location of the return type 

    The current strategy to place the rtype is still not fully satisfactory
on my own documentation. I think this improves it to avoid any need for
fudging.

1. If there is an existing :rtype: don't add another
2. If there is a :returns: anywhere, either add directly before it
   or modify the :returns: line as appropriate
3. If there is a block of :param: documentation, add directly after
   this
4. If there is a .. directive, add before the directive
5. Add at the end

Step 4 could be refined further, we would really only like to break at
directives that introduce headings
    @hoodmane
    hoodmane committed Jan 18, 2023
    Configuration menu
    Copy the full SHA
    87a6c91 View commit details
    Browse the repository at this point in the history

  2. Use docutils tree to figure out where params end

    @hoodmane
    hoodmane committed Jan 18, 2023
    Configuration menu
    Copy the full SHA
    98c3867 View commit details
    Browse the repository at this point in the history

  3. Fix changelog

    @hoodmane
    hoodmane committed Jan 18, 2023
    Configuration menu
    Copy the full SHA
    2542cde View commit details
    Browse the repository at this point in the history

  4. Fix test

    @hoodmane
    hoodmane committed Jan 18, 2023
    Configuration menu
    Copy the full SHA
    db15f3c View commit details
    Browse the repository at this point in the history

  5. Update comment

    @hoodmane
    hoodmane committed Jan 18, 2023
    Configuration menu
    Copy the full SHA
    f791e33 View commit details
    Browse the repository at this point in the history

  6. Update comment

    @hoodmane
    hoodmane committed Jan 18, 2023
    Configuration menu
    Copy the full SHA
    6558f0a View commit details
    Browse the repository at this point in the history