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

rewrite dostring folding #1807

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

drdv
Copy link

@drdv drdv commented Jun 7, 2020

PR Summary

Following #1774 and the modifications proposed in #1776, an alternative structure of the docstring folding code is suggested. The new implementation handles:

  • module-level docstrings
  • class docstrings
  • docstrings with both " and ' delimiters
  • comments (containing " and ') between function signature and its docstring

For each toggling, the function python-info-docstring-p is used only once. Two new unit tests have been added.

This PR was originally submitted at galaunay#6 (and later on moved here).

PR checklist

Please make sure that the following things have been addressed (and check the relevant checkboxes):

  • Commits respect our guidelines
  • Tests are passing properly (see here on how to run Elpy's tests)

For new features only:

  • Tests has been added to cover the change
  • The documentation has been updated

@coveralls
Copy link

Coverage Status

Coverage decreased (-3.2%) to 88.671% when pulling 22ef412 on drdv:even-better-docstring-folding into fa58b0b on jorgenschaefer:master.

@coveralls
Copy link

coveralls commented Sep 27, 2020

Coverage Status

Coverage remained the same at 91.843% when pulling 22ef412 on drdv:even-better-docstring-folding into fa58b0b on jorgenschaefer:master.

@galaunay
Copy link
Collaborator

Sorry for taking so long to have a look at this.
Could I ask you to rebase on the current master branch ?
(This should run the automated tests, which can help)

@drdv drdv force-pushed the even-better-docstring-folding branch from 22ef412 to f494578 Compare March 28, 2021 22:11
@galaunay galaunay force-pushed the master branch 4 times, most recently from c4a2564 to d974e00 Compare June 30, 2021 22:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants