3 ms·
This makes me think we should be able to put something like a standard tag for a 1-line summary (maybe embedded in some markdown in a comment) in a fashion the
by benjaminjackman 6y ago
This makes me think we should be able to put something like a standard tag for a 1-line summary (maybe embedded in some markdown in a comment) in a fashion the VCS's can detect & extract and then render in their UXs.
e.g. something very simple would probably work like the first line found that matches something like:
[Ignore_Non_Words]Summary[IgnorePunctuation&Spaces](Capture)
- PoignardAzur 6y agoI think you could get a lot of mileage from using existing formats in code and comments. So for instance, if save_parser.py starts with """ Parse content loaded from save files ... """ and math_backend.rs starts with //! List of data structures necessary for maths operations //! //! ... then your source tree UX should look like: src ├── save_parser.py # Parse content loaded from save files ├── math_backend.rs # List of data structures necessary for maths operations
- kitd 6y agoYou could probably solve most use cases by just pulling the first line from the readme in that folder. It would encourage people to write folder-level readmes if nothing else.