Re: underscores and dashes in docs



Owen Taylor wrote:
> 
> While updating gtk-doc to work with GObject parameters, I noticed,
> once again that we use a mix of dash-separated and underscore_separated
> conventions for argument names.
> 
> This, not suprisingly, causes various problems. I've just committed
> the following patch that standardizes both on dash-separated forms.
> This should work with both GTK+-1.2 based libs and GObject based
> libs.
> 
> >From C you can use either pretty interchangeably. For some other language
> bindings you need to use one or the other. In particular, in C++ you need
> to use the underscore_separated forms.
> 
> I don't have much of an opinion on which way we should go on this for
> the docs. If people feel strongly, I'll reverse the s/_/-/g to
> s/-/_/g.  We just need to standardize one way or the other.

Personally I prefer the '-' form, though I wouldn't mind using '_' if it
makes life much easier for C++ folks. But they probably have their own
docs instead.

Damon






[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]