Skip to content

Commit

Permalink
Updates README file with capitalised Class/Section names and table fo…
Browse files Browse the repository at this point in the history
…rmatting.
  • Loading branch information
rendertom committed Jun 23, 2018
1 parent 4c61f04 commit 802b655
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,19 +37,19 @@ Contributors are welcome and encouraged to suggest fixes, adjustments, notes/war

Anchors should be defined at each page setting relative to the root folder; the anchor for the "Application" page within the JS Object Reference should be::

.. _jsobjref/application
.. _jsobjref/Application

And the anchor for a child item (property, method or example)::

.. _jsobjref/application.open
.. _jsobjref/Application.open

Then, to link to these items from other pages, we use::

:ref:`jsobjref/application`
:ref:`jsobjref/Application`

or::

:ref:`jsobjref/application.open`
:ref:`jsobjref/Application.open`

----

Expand All @@ -61,6 +61,20 @@ These should follow the following structure::

----

**Tables**

Function parameter tables should have following order::

+---------------+------+-----------------------------+
| Parameter | Type | Description |
+===============+======+=============================+
| ``parameter`` | Type | What does the parameter do? |
+---------------+------+-----------------------------+

Use `Table Formatter <https://marketplace.visualstudio.com/items?itemName=shuworks.vscode-table-formatter>`_ for VSCode for easier table formating.

----

**Admonitions Usage**

Currently, the following `admonitions <http://docutils.sourceforge.net/docs/ref/rst/directives.html#admonitions>`_ are in use in this project. Try to keep one piece of data per note, for easier parsing.
Expand Down

0 comments on commit 802b655

Please sign in to comment.