Comments (1)
I think your title should say "doctests" instead of "docstrings", but I know what you mean.
As I mentioned in #9, my 2 criteria for including new folding functionality in this plugin are:
- Can it be implemented without making the code complicated?
- Is it universally desirable?
I am not sure this meets either criterion. For the first, I suspect that this would be more challenging to implement than you think. It is not sufficient to only fold docstring lines beginning with >>>
or ...
. Doctests also include expected output below the >>>
lines, which has no special prefix, and may extend to multiple lines. How do you tell where the doctest ends and the "normal" docstring resumes? While I'm sure that it is possible to do so by examining what the actual doctest
module does and reimplementing it in Vim, I can't imagine that the resulting code will be simple to understand.
For the second criterion, I do not think it is obvious that nearly every Python programmer would want this. I, for one, would rather not have doctests fold separately. I would still accept such a feature if it were opt-in; i.e. disabled by default but toggled on by a variable that could be set from the user's .vimrc
.
So, if you want to write a patch for this, I'll accept it, provided that it is well-written and does not overly complicate the code, does not fail to fold correctly in any unusual corner cases, and is disabled unless the user enables it in their .vimrc
.
I appreciate the suggestion, whether or not we end up including it.
from simpylfold.
Related Issues (20)
- Folds are invalid after running formatter with ale HOT 3
- Releases Support HOT 1
- More configuration HOT 2
- SimpylFold with large modules makes basic operations slow HOT 3
- Auto close fold include current line after delete line HOT 5
- Comment BLOCKS (in file licenses)
- Plugin ceases to work if a module is named after its parent directory HOT 1
- docstring folding not working with empty line HOT 2
- Support folding long block of code by indentation? HOT 4
- Plugin is not working on Ubuntu Vi IMproved 8.0 HOT 3
- Folds only exist after using zx (E490: No fold found) when using "telescope" fzf plugin HOT 6
- Support for other languages? HOT 1
- is it possible to have only 1 line separating folds ? HOT 2
- the function/class names should have an higher contrast than the lines numbers HOT 3
- Possibility of defining custom folds? HOT 1
- Repository not found HOT 1
- Folding Code in Child Classes HOT 2
- SimpylFold won't indent top level functions HOT 4
- Can't turn off docstring folding HOT 5
- SimpylFold not working (E490: no fold found) on macOS Sonoma with Vundle HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from simpylfold.