[QGIS-Developer] Identify [feature] tagged reports that are not worth documenting

[DelazJ]

Hi,

Not really! In my suggestion [no-docs] was supposed to alert docs writers
so that they close the issue immediately. In yours, it blocks the creation
of the issue report, which is far better. ;)

And thanks for the impressive cleanup of the list.

Harrissou

2018-06-22 0:34 GMT+02:00 Nyall Dawson <nyall.dawson at gmail.com>:

> On Fri, 22 Jun 2018 at 08:34, Nyall Dawson <nyall.dawson at gmail.com> wrote:
> >
> >
> > On Thu, 21 Jun 2018 at 22:56, DelazJ <delazj at gmail.com> wrote:
> > >
> > > Hi,
> > >
> > > The [FEATURE] tagged pull-requests are used to advertize devs of a new
> feature but also populate both doc issue repo and changelog.
> > > While the automatic issue report is really really great, not all the
> [features] implementations are worth mentioning in the user manuals,
> sometimes because it's a low-level feature eg and has interest only for the
> changelog.
> > > The side effect is that we end up with a growing queue in the doc repo
> and i'm afraid that in the doc team we do not have all the background (I'm
> referring at least to myself) to always quickly identify (and understand)
> whether a feature needs documentation or should be closed as unresolved.
> You can find an introductory list at https://github.com/qgis/QGIS-
> Documentation/labels/ToDocOrNotToDoc%3F (still incomplete as it needs
> someone to browse the list and weigh the interest of the report - your
> opinion is btw welcome on those)
> > >
> > > I guess, you devs might have some more ideas whether a feature you are
> writing may be of interest in user doc. So could we imagine another tag eg
> [no-docs] that will be added to the list of automatic issue triggers?
> Actually it'll only be used along the [feature] tag to indicate that it's a
> new feature (for changelog or whatever) but do not waste your time on
> trying to write about in docs.
> > >
> > > Does it sound a workable proposal? Anything better?
> >
> > Good idea! I had a quick look at the queue and closed some stuff.
> >
> > I noticed there's a lot of open auto tickets caused by API additions
> which are marked as [feature]. These are features in a sense, but don't
> need documenting (outside of the regular code documentation). I wonder if
> it would be worthwhile introducing a "[no-docs]" tag which could be used
> alongside "[feature]" to avoid the auto-opened ticket?
>
> Man... I'm going blind. I just realised you suggested EXACTLY the same
> thing at the end of your email :)
>
> Nyall
>
> >
> > Nyall
> >
> >
> >
> > >
> > > Cheers,
> > > Harrissou
> > > _______________________________________________
> > > QGIS-Developer mailing list
> > > QGIS-Developer at lists.osgeo.org
> > > List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
> > > Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20180622/972921ab/attachment-0001.html>