4 ms·

suggestions: - allow authors to write a general overview (with links to methods) of the design philosophy, tradeoffs accepted, stuff that they would do differe

suggestions: - allow authors to write a general overview (with links to methods) of the design philosophy, tradeoffs accepted, stuff that they would do differently now, etc. This could help generate smart pull requests for bigger / more significant features too. - allow people to ask questions about a line of code. - allow people to request/contribute better documentation, categorized as api docs, usage examples, etc. - Allow the author to "accept" an annotation as literate comments submitted as a fork/pr via github. - let users follow a method or class. - let users generate a list of methods to follow in a library based on hot path analysis of library use (maybe I only use 3 methods and would love to see changes to those coming from upstream) - let users contribute method rewrites or unit tests of individual methods as annotations. - ideally dialogues would ensue about clever/clear ways to implement things. I'd enjoy reading those dialogues.

timr 12y ago
Wow, thanks for the feedback! Some specific responses: "allow people to ask questions about a line of code." we do this now! highlight a line of code, and you'll see a prompt. "Allow the author to "accept" an annotation as literate comments submitted as a fork/pr via github." That's a good idea. We'll need to work out the model (i.e. is it opt-in for the maintainer?) so that we don't irritate people with unsolicited requests, but I like it. "let users follow a method or class." This is coming soon! Following was naively implemented in the simplest way possible. We're expanding it now. "let users generate a list of methods to follow in a library based on hot path analysis of library use" Oh, that's interesting...will have to ponder it for a while.... If you have anything else, just shoot us an email: support@omniref.com. That goes to both of us, and we reply to just about everything we get (most of our current features came from direct user requests!)

timr 12y ago

Wow, thanks for the feedback! Some specific responses: "allow people to ask questions about a line of code." we do this now! highlight a line of code, and you'll see a prompt. "Allow the author to "accept" an annotation as literate comments submitted as a fork/pr via github." That's a good idea. We'll need to work out the model (i.e. is it opt-in for the maintainer?) so that we don't irritate people with unsolicited requests, but I like it. "let users follow a method or class." This is coming soon! Following was naively implemented in the simplest way possible. We're expanding it now. "let users generate a list of methods to follow in a library based on hot path analysis of library use" Oh, that's interesting...will have to ponder it for a while.... If you have anything else, just shoot us an email: support@omniref.com. That goes to both of us, and we reply to just about everything we get (most of our current features came from direct user requests!)