omeka / Documentation

Documentation and tutorials for theme and plugin developers
Other
6 stars 27 forks source link

Update public_url.rst #26

Closed steveknoblock closed 7 years ago

steveknoblock commented 10 years ago

Added function description with parameters.

zerocrates commented 10 years ago

Thanks, Steve. I haven't gotten around to this like I said I would.

The problem is, that file you edited is automatically generated from the Omeka source code. It would get clobbered the next time we updated anything. A real fix here requires us to go into the Omeka code and add PHPDoc annotations for public_url and admin_url, so they'll generate correctly.

The short-term possibility is just adding a simple sentence and link to the url() docs to the summary/public_url.rst. The summary, usage, examples, and see_also files are set up so that they can be manually edited and they'll persist even when we update the docs from the Omeka source.

zerocrates commented 9 years ago

The "just make a link" "fix" to this got done a little while ago, in 09159f36dfd4ff20e7b1ada22cb7a86bb061bf00