private_comments
Dash-User-Contributions
| private_comments | Dash-User-Contributions | |
|---|---|---|
| 2 | 2 | |
| 42 | 1,974 | |
| - | - | |
| 0.0 | 9.9 | |
| 6 months ago | 3 days ago | |
| Scheme | Python | |
| - | - |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
private_comments
-
I’m a Productive Programmer with a Memory of a Fruit Fly
I wrote Private Comments[1] specifically to address this problem in code. My coworkers can maintain context about how a given thing works months after the fact. I can't. So, I leave private comments throughout the code. Things they'd never want committed, but save me hours of re-leaning when next i encounter a given piece of code.
Currently has plugins for Vim (proof of concept) and Emacs (actually good). It'd be lovely if one of you folks would make a VSCode plugin for it. I've thoroughly documented the API and diagrammed the code flow you'd need[2], so that this would be as easy as possible to add to your favorite editor.
[1]: https://github.com/masukomi/private_comments
[2]: https://masukomi.github.io/private_comments/
-
I will pay you to write this plugin for me
A while ago I wrote a mini API server in order to let me leave "private comments" on a codebase.
Dash-User-Contributions
-
Zeal is an offline documentation browser for software developers
https://github.com/chinmaygarde/doxygen2docset or https://pypi.org/project/doxytag2zealdb.
Otherwise is it probably best to look for a specific tool for the type of docs and then look through the GitHub submissions to the user-generated docset submissions for clues for specific code bases: https://github.com/Kapeli/Dash-User-Contributions/pulls?q=is...
-
I’m a Productive Programmer with a Memory of a Fruit Fly
Dash looks like a great project but the community doc contributions are a security concern. Docs are uploaded to git as Tars, nothing is stopping someone from adding malicious code to these tar uploads which developers will download unknowingly when they add a community doc.
See: https://github.com/Kapeli/Dash-User-Contributions
What are some alternatives?
emacs-virtual-comment - Virtual Comments for Emacs
devdocs.el - Emacs viewer for DevDocs
phantom-inline-comment - visible but not affect the source code
doc-browser - A documentation browser with support for DevDocs, Dash and Hoogle, written in Haskell and QML
i3-cheatsheet-hot-key - Provides a hot key for creating/opening a custom cheatsheet for the window(application) in focus
ase-docset
vim_private_comments - a vim plugin for private comments
helm-dash - Browse Dash docsets inside emacs
doxygen2docset - From Doxygen documentation, create a Docset for use in Dash or Zeal.