After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 772412 - clutter-script: Document support for top-level arrays
clutter-script: Document support for top-level arrays
Status: RESOLVED FIXED
Product: clutter
Classification: Platform
Component: Documentation
unspecified
Other All
: Normal normal
: ---
Assigned To: clutter-maint
clutter-maint
Depends on:
Blocks:
 
 
Reported: 2016-10-04 15:49 UTC by Philip Withnall
Modified: 2016-11-21 21:18 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
clutter-script: Document support for top-level arrays (2.40 KB, patch)
2016-10-04 15:49 UTC, Philip Withnall
committed Details | Review

Description Philip Withnall 2016-10-04 15:49:34 UTC
Simple patch attached.
Comment 1 Philip Withnall 2016-10-04 15:49:37 UTC
Created attachment 336907 [details] [review]
clutter-script: Document support for top-level arrays

Despite being a widely-used feature, it doesn’t seem to be obvious from
the documentation that the top-level node in a ClutterScript JSON file
can be an object, or an array of objects. Try to clarify that in the
documentation.
Comment 2 Philip Withnall 2016-11-21 11:43:07 UTC
Ping for review?
Comment 3 Emmanuele Bassi (:ebassi) 2016-11-21 11:51:46 UTC
Review of attachment 336907 [details] [review]:

::: clutter/clutter-script.c
@@ +74,3 @@
+ * Multiple objects can be defined using an array:
+ *
+ * <informalexample><programlisting><![CDATA[

Shouldn't this XML be replaced by:

    |[<!-- language="plain" -->
    ...
    ]|

?
Comment 4 Philip Withnall 2016-11-21 20:43:56 UTC
(In reply to Emmanuele Bassi (:ebassi) from comment #3)
> Review of attachment 336907 [details] [review] [review]:
> 
> ::: clutter/clutter-script.c
> @@ +74,3 @@
> + * Multiple objects can be defined using an array:
> + *
> + * <informalexample><programlisting><![CDATA[
> 
> Shouldn't this XML be replaced by:
> 
>     |[<!-- language="plain" -->
>     ...
>     ]|
> 
> ?

Ideally, yes. I went with <informalexample> because that’s what the rest of the file uses, but I can switch to the new syntax before pushing if you want?

Any other issues?
Comment 5 Emmanuele Bassi (:ebassi) 2016-11-21 21:02:11 UTC
(In reply to Philip Withnall from comment #4)
> (In reply to Emmanuele Bassi (:ebassi) from comment #3)
> > Review of attachment 336907 [details] [review] [review] [review]:
> > 
> > ::: clutter/clutter-script.c
> > @@ +74,3 @@
> > + * Multiple objects can be defined using an array:
> > + *
> > + * <informalexample><programlisting><![CDATA[
> > 
> > Shouldn't this XML be replaced by:
> > 
> >     |[<!-- language="plain" -->
> >     ...
> >     ]|
> > 
> > ?
> 
> Ideally, yes. I went with <informalexample> because that’s what the rest of
> the file uses, but I can switch to the new syntax before pushing if you want?

That would be great.

> Any other issues?

Nope, with that fixed it's ACK-by: me.
Comment 6 Philip Withnall 2016-11-21 21:18:33 UTC
Pushed with that change, thanks. :-)

Attachment 336907 [details] pushed as c05dc54 - clutter-script: Document support for top-level arrays