[dev] Seeking Documentation/Error Advice

[Eric Rostetter]

Quoting Rick Emery <rick at emery.homelinux.net>:

> There has been some concern over the new horde metar block, namely that there
> isn't any documentation about the requirement of pear's Services_Weather
> module or the need to run the buildMetarDB script. If either of these
> requirements isn't  met, it doesn't fail gracefully.

Can it be made to fail gracefully?

> I'm looking for advice on how to handle this.

Document it, and if possible make it fail gracefully.  But don't feel
too much presure since it is HEAD code.  It should at least be put on
the TODO list though.

> Where should the need for Services_Weather be documented?

In horde/docs/INSTALL if it is part of the portal, in jonah/docs/INSTALL
if it is part of Jonah.  IIRC, it is being removed from Jonah and put in
the portal?  If so, then in horde/docs/INSTALL.

> I could add a check
> to test.php, but it isn't really required for horde to function. If the

Doesn't matter.  We put things in there that are not needed.  Just make sure
any error message says "it is only needed if you use the metar block" or
something like that.  There are other such things already in test.php.

> system
> isn't going to use the metar block, Services_Weather isn't needed.

Yes, just state that in any messages.

> I guess I could return an error if the buildMetarDB script hasn't been run
> (and
> hence, the location tables don't exist), or would it be better to display a
> meaningful message (something like "the buildMetarDB script must be run to
> place the location tables in the horde database").

Anything that alerts the admin (not the user) to the problem is good.

> Thanks in advance for any advice/comments/suggestions.
>
> --
> Rick Emery
>
> "When once you have tasted flight, you will forever walk the Earth
>  with your eyes turned skyward, for there you have been, and there
>  you will always long to return"
>                                               -- Leonardo Da Vinci
>
>
> --
> Horde developers mailing list
> Frequently Asked Questions: http://horde.org/faq/
> To unsubscribe, mail: dev-unsubscribe at lists.horde.org
>


--
Eric Rostetter
The Department of Physics
The University of Texas at Austin

Why get even? Get odd!