Opened 12 years ago

Closed 6 years ago

#1722 closed defect (fixed)

to avoid confusion, call it ReST or reST not Rest

Reported by: hamish Owned by: grass-dev@…
Priority: normal Milestone: 7.0.7
Component: Compiling Version: svn-trunk
Keywords: reST, docs, rst Cc:
CPU: All Platform: All

Description

Hi,

to avoid confusion with other RESTs (such as representational state transfer- the RESTful API, a friend of SOAP) please always spell out reStructuredText completely in comments, and lower-case the "e" and/or "r" as appropriate when used in abbrv.

e.g.

FILES="
include/Make/Etc.make
include/Make/Lib.make
include/Make/Module.make
include/Make/Other.make
include/Make/Dir.make
include/Make/Multi.make
include/Make/Script.make
include/Make/DB.make
man/build_rest.py
imagery/i.find/Makefile
lib/gtcltk/Makefile
raster/r.watershed/ram/Makefile
raster/r.watershed/seg/Makefile
tools/timer/Makefile"

sed -i -e 's/Rest/ReST/' $FILES
svn mv include/Make/ReST.make include/Make/ReST.make
svn mv include/Make/NoRest.make include/Make/NoReST.make

It is rather likely that some part of GRASS will be linked to a RESTful API interface in the near future, actually that's probably already happened.

thanks, Hamish

Change History (6)

comment:1 by wenzeslaus, 9 years ago

Keywords: rst added

API changes (--rest-description to --rst-description) done in r63780 (backported in r63818 to 70) but more is needed.

comment:2 by martinl, 8 years ago

Milestone: 7.0.07.0.5

comment:3 by neteler, 7 years ago

Milestone: 7.0.57.0.6

comment:4 by neteler, 6 years ago

Milestone: 7.0.67.0.7

comment:5 by martinl, 6 years ago

What is the state of this ticket?

comment:6 by neteler, 6 years ago

Resolution: fixed
Status: newclosed

It appears to work as desired:

g.version --rst-description
===========================
GRASS GIS manual: g.version
===========================

.. figure:: grass_logo.png
   :align: center
   :alt: GRASS logo

...

(and the unrelated REST API development is also happening, see for example http://openeo.org)

I am closing this as solved, long time ago.

Note: See TracTickets for help on using tickets.