On Tue, Mar 12, 2013 at 7:47 AM, Ryan Schmidt <ryandes...@macports.org> wrote:

> Notes shouldn't introduce manual line breaks in the middles of sentences; 
> when displayed, MacPorts inserts line breaks into the notes automatically for 
> you where appropriate for the current width of the terminal window.
>
> Decorations like "--------" shouldn't be used to frame notes; it gives the 
> impression that the author feels this port's notes are more important than 
> other ports' notes, which I don't think we want to convey. Just let the notes 
> be the text that you want displayed, and let MacPorts handle the details of 
> how they're displayed. If it is thought that notes are not displayed 
> prominently enough, then let that problem be solved globally at the MacPorts 
> base level rather than individually for each port.

Can we put something about notes based on what you just wrote in the
guide, portfile development chapter? I think it'd be an useful
reference.

-- 
Andrea
_______________________________________________
macports-dev mailing list
macports-dev@lists.macosforge.org
https://lists.macosforge.org/mailman/listinfo/macports-dev

Reply via email to