[pgrouting-dev] Doc for Legacy file

Hi Daniel,

I reviewed the src/common/sql/pgrouting_legacy.sql today and:

1. added the shooting_star function in addition to the shooting_star wrapper that was already there. Both of these function raise and exception noting that this functionality has been drop in 2.0 and user need to migrate to pgr_trsp() function.

2. created src/common/doc/legacy.rst which needs to be linked into the documentation somewhere. My goals for this page are:
   a. Explain why these functions are gone from the release
   b. make it clear that these functions are not support and not tested
   c. Explain that we are temporarily providing this unsupported file in the hope it might be useful
   d. list without explanation what functions are in the file as kind of a quick reference

Feel free to make changes. This closes issue #100

Thanks,
   -Steve

On Fri, May 31, 2013 at 12:58 AM, Stephen Woodbridge <
woodbri@swoodbridge.com> wrote:

Hi Daniel,

I reviewed the src/common/sql/pgrouting_**legacy.sql today and:

1. added the shooting_star function in addition to the shooting_star
wrapper that was already there. Both of these function raise and exception
noting that this functionality has been drop in 2.0 and user need to
migrate to pgr_trsp() function.

2. created src/common/doc/legacy.rst which needs to be linked into the
documentation somewhere. My goals for this page are:
  a. Explain why these functions are gone from the release
  b. make it clear that these functions are not support and not tested
  c. Explain that we are temporarily providing this unsupported file in
the hope it might be useful
  d. list without explanation what functions are in the file as kind of a
quick reference

Feel free to make changes. This closes issue #100

Thanks!
It could fit within or around "discontinued functions":
http://docs.pgrouting.org/dev/doc/src/developer/discontinued.html

Daniel

--
Georepublic UG & Georepublic Japan
eMail: daniel.kastl@georepublic.de
Web: http://georepublic.de

On 5/30/2013 12:14 PM, Daniel Kastl wrote:

On Fri, May 31, 2013 at 12:58 AM, Stephen Woodbridge
<woodbri@swoodbridge.com <mailto:woodbri@swoodbridge.com>> wrote:

    Hi Daniel,

    I reviewed the src/common/sql/pgrouting___legacy.sql today and:

    1. added the shooting_star function in addition to the shooting_star
    wrapper that was already there. Both of these function raise and
    exception noting that this functionality has been drop in 2.0 and
    user need to migrate to pgr_trsp() function.

    2. created src/common/doc/legacy.rst which needs to be linked into
    the documentation somewhere. My goals for this page are:
       a. Explain why these functions are gone from the release
       b. make it clear that these functions are not support and not tested
       c. Explain that we are temporarily providing this unsupported
    file in the hope it might be useful
       d. list without explanation what functions are in the file as
    kind of a quick reference

    Feel free to make changes. This closes issue #100

Thanks!
It could fit within or around "discontinued functions":
http://docs.pgrouting.org/dev/doc/src/developer/discontinued.html

Daniel

Sure, I didn't know you already had this page. So if you want to move or merge it that would be fine with me.

Thanks,
   -Steve