Opened 10 years ago

Closed 6 years ago

Last modified 6 years ago

#2767 closed defect (fixed)

AddRasterConstraint with 2 arguments is not documented

Reported by: strk Owned by: robe
Priority: medium Milestone:
Component: documentation Version: master
Keywords: postgisraster Cc:

Description

You can call AddRasterConstraint(<tablename>, <fieldname>) but the documentation doesn't mention it: http://postgis.net/docs/RT_AddRasterConstraints.html

Change History (10)

comment:1 by strk, 10 years ago

Keywords: postgisraster added

comment:2 by sunveersingh, 6 years ago

Hello, I would live to work on this issue as a part of my Google Code-in 2018 task

comment:3 by komzpa, 6 years ago

sunveersingh great!

Is there something we can help you with?

The file that should contain the documentation is https://github.com/postgis/postgis/blob/svn-trunk/doc/reference_raster.xml

You can make a pull request with a change to it on github. To test whether your edit didn't break document structure, run "make check" in root directory of your check out.

comment:4 by sunveersingh, 6 years ago

komzpa Thanks!

I just got one question, should I create a note section and add " The user can call AddRasterConstraint(<tablename>, <fieldname>)", and where in the document I guess before example it would be ok.

Last edited 6 years ago by sunveersingh (previous) (diff)

comment:5 by komzpa, 6 years ago

There is already one in the examples, but not in Synopsis.

What needs to be added is a row in Synopsis, that would go by analogy of the ones in here:

https://github.com/postgis/postgis/blob/svn-trunk/doc/reference_raster.xml#L493

comment:6 by sunveersingh, 6 years ago

ok it will be like: <funcprototype>

<funcdef>boolean <function>AddRasterConstraints</function></funcdef> <paramdef><type>name </type> <parameter>tablename</parameter></paramdef>

<paramdef><type>name </type> <parameter><fieldname></parameter></paramdef>

</funcprototype>

or something else?

comment:7 by komzpa, 6 years ago

Yes, something like that.

comment:8 by komzpa, 6 years ago

Resolution: fixed
Status: newclosed

In 16996:

Documentation for AddRasterConstraint optional parameters

Patch by Sunveer Singh

Closes #2767
Closes https://github.com/postgis/postgis/pull/325

comment:9 by komzpa, 6 years ago

In 16997:

Documentation for AddRasterConstraint optional parameters

Patch by Sunveer Singh

Closes #2767
Closes https://github.com/postgis/postgis/pull/325

comment:10 by sunveersingh, 6 years ago

Thanks a lot!

Note: See TracTickets for help on using tickets.