I suggest you ...

← General

Editable doc string

HTML supports more formatting than doc strings. Var documentation could be an editable wiki, like the examples, that starts off with the doc string embedded in a <pre> block. Users would then be able to update the documentation to fix spelling errors, improve formatting, etc.

5 votes
Vote
Sign in
Check!
(thinking…)
Reset
or sign in with
  • facebook
  • google
    Password icon
    Forgot password?
    Create a password
    I agree to the terms of service
    Signed in as (Sign out)
    Close
    Close
    You have left! (?) (thinking…)
    anonymousanonymous shared this idea  ·   ·  Admin →

    2 comments

    Sign in
    Check!
    (thinking…)
    Reset
    or sign in with
    • facebook
    • google
      Password icon
      Forgot password?
      Create a password
      I agree to the terms of service
      Signed in as (Sign out)
      Close
      Close
      Submitting...
      • zkimAdminzkim (Admin, ClojureDocs) commented  · 

        I'm inclined to agree with Dimitry, but anon makes some good points on providing a feedback mechanism to improve docstrings.

        Christopher Maier and Dennis Crenshaw suggested a very similar feature at the conj: A place to discuss perceived deficiencies and suggest improvements for docstrings on ClojureDocs.

        https://github.com/zkim/clojuredocs/issues#issue/21

      • Dmitry KakurinDmitry Kakurin commented  · 

        Forking documentation into official and user-editable is a bad idea.

      General

      Feedback and Knowledge Base

      (thinking…)