Documentation for ucomment

Hide comments

Support, maintenance, license, and release history

Support

The author of ucomment will fix any bugs reported at the Bitbucket site for this application.

Feature suggestions and other feedback regarding the code structure and possible improvements are gratefully accepted: kgdunn@gmail.com

License

Note

The code is licensed under the 2-clause, simplified BSD license.

Copyright 2010 Kevin G. Dunn, All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY Kevin G. Dunn “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Kevin G. Dunn OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of Kevin G. Dunn.

Maintenance

I plan to maintain this package, since I regularly use it for work. The code is released under the BSD license, which allows you to modify it for your own needs, in the event that I’m not able to help you out.

Release 0.14

10 January 2011: A minor releases to fix some bugs and add minor features. You can see all changesets from the Bitbucket site.

Release 0.1

27 October 2010: First public release after several months (May to October) of internal development.

Contribute your comments (this window can be dragged out of the way)X

(Please read the help on commenting)

Want to add to the discussion? Please click here.

About this comment system

This pages uses a commenting system to obtain your feedback. Feel free to ask questions, provide your perspective, or leave a relevant comment on any block of text, bullet point, code, or chunck of content.

To get started, please click on the vertical sidebar, near the content you would like to comment on. It will highlight the section you are commenting on.

Shows how the comment system works

After being approved, your comment will appear on the website. Please provide your name and email address if you would like to receive credit for your contribution.

Please note that we reserve the right to edit or remove a comment, and that you give us permission to use your contribution.

How to comment

  • Italics:    *italic text*
  • Bold text:     **bold text**
  • monospaced text:     ``monospaced text`` (use backquotes)
  • Hyperlinks are automatically detected:      http://ucomment.org shows up as http://ucomment.org
  • Unnumbered bullet points use * asterisks, while numbered points use a # hash mark.
    * This is a bulleted list.
    * It has two items, the second
      item uses two lines.
      #. Point one.
      #. Point two.
    
  • Mathematics: \(e^{i\pi} + 1 = 0\) will show as Euler's famous equation, \(e^{i\pi} + 1 = 0\), if the site administrator has allowed mathematics in the comments. Similarly, you can use \[ ... \] to write a stand-alone mathematical equation.

    See this page for help with writing math equations.

Tables, source code and other elements can also be added to your comment; please read more here.