>
> Federico:
>
> This looks really good. My comments below are all NITS, and only
> intended to encourage more consistant language and stronger definitions.
> I'm not wed to the terms/definitions I suggest. If there are other
> terms/definitions that make better sense, please suggest them.
>
>>
[snip]
> Better
> still, we could ask desktop module maintainers to publish a list
> of undocumented interfaces shortly after feature freeze. That
> would encourage potential documentation contributors.
Yes, if we can get gtk-doc to generate lists of undocumented API, and then
link to all these p
Federico:
This looks really good. My comments below are all NITS, and only
intended to encourage more consistant language and stronger definitions.
I'm not wed to the terms/definitions I suggest. If there are other
terms/definitions that make better sense, please suggest them.
Some time ago
On Fri, 2005-12-02 at 10:33 -0500, JP Rosevear wrote:
> On Wed, 2005-11-30 at 19:03 -0600, Federico Mena Quintero wrote:
> > Hi,
> >
> > Some time ago we discussed adding a requirement for new APIs that enter
> > the core platform [1]: those modules which add new APIs must provide
> > documentati
On Wed, 2005-11-30 at 19:07 -0600, Federico Mena Quintero wrote:
> [Argh, hit "Send" too soon, sorry about that. Let's try again.]
>
> Hi,
>
> Some time ago we discussed adding a requirement for new APIs that enter
> the core platform [1]: those modules which add new APIs must provide
> documen
On Fri, 2005-12-02 at 10:33 -0500, JP Rosevear wrote:
> Is there a deadline for when this has to be done by? Getting to the
> hard freeze and then realizing, "oops not done, but people now depend on
> the API" would be a bad thing.
Yes, the deadline is one week after API freeze. For this releas
On Fre, 2005-12-02 at 10:33 -0500, JP Rosevear wrote:
> Is there a deadline for when this has to be done by? Getting to the
> hard freeze and then realizing, "oops not done, but people now depend on
> the API" would be a bad thing.
Deadlines
In each release cycle, the deadline for API documentati
On Wed, 2005-11-30 at 19:03 -0600, Federico Mena Quintero wrote:
> Hi,
>
> Some time ago we discussed adding a requirement for new APIs that enter
> the core platform [1]: those modules which add new APIs must provide
> documentation for those APIs. Thanks to Murray for bringing it up, and
> for
On Thu, 2005-12-01 at 06:58 -0500, Daniel Veillard wrote:
> That comes out of the blue for me. I'm not adverse to this, but as one
> of the affected modules maintainers I would have loved to heard from it
> before, especially as I don't use gtk-doc (I tried for years and finally
> wrote my own s
> 1. Document any new public interfaces since the last stable version
> of the module (e.g. the jump from 2.12.x to 2.14.0). You can do
> this with gtk-doc.
>
>
> This says that you can use gtk-doc. It doesn't say you must use
> gtk-doc. Why do you need to change your tools?
Daniel Veillard wrote:
>>whatever documentation system you use, you can still document the
>>undocumented things and force documentation for all new API to be
>>written, right?
>>
>>
>
> I will have to change my tools, but yes.
>
>
Federico's mail read:
1. Document any new public inte
On Thu, Dec 01, 2005 at 01:18:00PM +0100, Rodrigo Moya wrote:
> On Thu, 2005-12-01 at 06:58 -0500, Daniel Veillard wrote:
> > On Wed, Nov 30, 2005 at 07:03:50PM -0600, Federico Mena Quintero wrote:
> > > Hi,
> > >
> > > Some time ago we discussed adding a requirement for new APIs that enter
> > >
On Thu, 2005-12-01 at 06:58 -0500, Daniel Veillard wrote:
> On Wed, Nov 30, 2005 at 07:03:50PM -0600, Federico Mena Quintero wrote:
> > Hi,
> >
> > Some time ago we discussed adding a requirement for new APIs that enter
> > the core platform [1]: those modules which add new APIs must provide
> >
On Wed, Nov 30, 2005 at 07:03:50PM -0600, Federico Mena Quintero wrote:
> Hi,
>
> Some time ago we discussed adding a requirement for new APIs that enter
> the core platform [1]: those modules which add new APIs must provide
> documentation for those APIs. Thanks to Murray for bringing it up, an
[Argh, hit "Send" too soon, sorry about that. Let's try again.]
Hi,
Some time ago we discussed adding a requirement for new APIs that enter
the core platform [1]: those modules which add new APIs must provide
documentation for those APIs. Thanks to Murray for bringing it up, and
for resurrecti
Hi,
Some time ago we discussed adding a requirement for new APIs that enter
the core platform [1]: those modules which add new APIs must provide
documentation for those APIs. Thanks to Murray for bringing it up, and
for resurrecting the discussion.
The release team has decided that we'll try th
16 matches
Mail list logo
