You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@shindig.apache.org by Erel Segal <er...@gmail.com> on 2008/07/01 15:08:21 UTC
documentation patches
I began reading the PHP source code, and while trying to understand it, I
made some changes and additions to the internal documentation. Is it
worthwhile to submit these changes as patches, to help other newbies like
me?
Re: documentation patches
Posted by Erel Segal <er...@gmail.com>.
OK, here is my documentation patch, I hope this helps:
https://issues.apache.org/jira/browse/SHINDIG-452
2008/7/2, Erel Segal <er...@gmail.com>:
>
> In addition, I think you can add the class RestServlet to figure 2.
>
> 2008/7/1, Erel Segal <er...@gmail.com>:
>
>> "Figure 3 : Class diagram of the GadgetDataServlet and its related classes
>> used to reset and access the Open Social state." The title is there, but I
>> can't see the figure.
>>
>> Initially I thought the figure is just below the title, but the figure
>> below the title is actually "Figure 4 : Sequence diagram explaining how the
>> SampleContainer.html is loaded by the FilesServlet.php".
>>
>>
>>
>>
>> 2008/7/1, Gonzalo Aune <go...@gmail.com>:
>>>
>>> Which one?, i can see all of them.
>>>
>>>
>>> G.-
>>>
>>>
>>> On Tue, Jul 1, 2008 at 12:54 PM, Erel Segal <er...@gmail.com> wrote:
>>>
>>> > This is great, thank you!
>>> >
>>> > I think figure 3 is missing.
>>> >
>>> >
>>> > 2008/7/1, Gonzalo Aune <go...@gmail.com>:
>>> > >
>>> > > You can take a look at this guide:
>>> > > http://rajdeep.dua.googlepages.com/shindigPHP-overview-tidy_img.html
>>> > >
>>> > >
>>> > > G.-
>>> > >
>>> > >
>>> > > On Tue, Jul 1, 2008 at 10:31 AM, Erel Segal <er...@gmail.com>
>>> wrote:
>>> > >
>>> > > > OK. Is there already some external documentation to the PHP source
>>> code
>>> > > > (e.g. explaining what classes there are , what each class does,
>>> etc...)
>>> > > >
>>> > > > 2008/7/1, Gonzalo Aune <go...@gmail.com>:
>>> > > > >
>>> > > > > Of course!!, all help is very much appreciated, thanks Erel!
>>> > > > >
>>> > > > >
>>> > > > > G.-
>>> > > > >
>>> > > > >
>>> > > > > On Tue, Jul 1, 2008 at 10:08 AM, Erel Segal <er...@gmail.com>
>>> > wrote:
>>> > > > >
>>> > > > > > I began reading the PHP source code, and while trying to
>>> understand
>>> > > it,
>>> > > > I
>>> > > > > > made some changes and additions to the internal documentation.
>>> Is
>>> > it
>>> > > > > > worthwhile to submit these changes as patches, to help other
>>> > newbies
>>> > > > like
>>> > > > > > me?
>>> > > > > >
>>> > > > >
>>> > > >
>>> > >
>>> >
>>>
>>
>>
>
Re: documentation patches
Posted by Erel Segal <er...@gmail.com>.
In addition, I think you can add the class RestServlet to figure 2.
2008/7/1, Erel Segal <er...@gmail.com>:
>
> "Figure 3 : Class diagram of the GadgetDataServlet and its related classes
> used to reset and access the Open Social state." The title is there, but I
> can't see the figure.
>
> Initially I thought the figure is just below the title, but the figure
> below the title is actually "Figure 4 : Sequence diagram explaining how the
> SampleContainer.html is loaded by the FilesServlet.php".
>
>
>
>
> 2008/7/1, Gonzalo Aune <go...@gmail.com>:
>>
>> Which one?, i can see all of them.
>>
>>
>> G.-
>>
>>
>> On Tue, Jul 1, 2008 at 12:54 PM, Erel Segal <er...@gmail.com> wrote:
>>
>> > This is great, thank you!
>> >
>> > I think figure 3 is missing.
>> >
>> >
>> > 2008/7/1, Gonzalo Aune <go...@gmail.com>:
>> > >
>> > > You can take a look at this guide:
>> > > http://rajdeep.dua.googlepages.com/shindigPHP-overview-tidy_img.html
>> > >
>> > >
>> > > G.-
>> > >
>> > >
>> > > On Tue, Jul 1, 2008 at 10:31 AM, Erel Segal <er...@gmail.com>
>> wrote:
>> > >
>> > > > OK. Is there already some external documentation to the PHP source
>> code
>> > > > (e.g. explaining what classes there are , what each class does,
>> etc...)
>> > > >
>> > > > 2008/7/1, Gonzalo Aune <go...@gmail.com>:
>> > > > >
>> > > > > Of course!!, all help is very much appreciated, thanks Erel!
>> > > > >
>> > > > >
>> > > > > G.-
>> > > > >
>> > > > >
>> > > > > On Tue, Jul 1, 2008 at 10:08 AM, Erel Segal <er...@gmail.com>
>> > wrote:
>> > > > >
>> > > > > > I began reading the PHP source code, and while trying to
>> understand
>> > > it,
>> > > > I
>> > > > > > made some changes and additions to the internal documentation.
>> Is
>> > it
>> > > > > > worthwhile to submit these changes as patches, to help other
>> > newbies
>> > > > like
>> > > > > > me?
>> > > > > >
>> > > > >
>> > > >
>> > >
>> >
>>
>
>
Re: documentation patches
Posted by Erel Segal <er...@gmail.com>.
"Figure 3 : Class diagram of the GadgetDataServlet and its related classes
used to reset and access the Open Social state." The title is there, but I
can't see the figure.
Initially I thought the figure is just below the title, but the figure below
the title is actually "Figure 4 : Sequence diagram explaining how the
SampleContainer.html is loaded by the FilesServlet.php".
2008/7/1, Gonzalo Aune <go...@gmail.com>:
>
> Which one?, i can see all of them.
>
>
> G.-
>
>
> On Tue, Jul 1, 2008 at 12:54 PM, Erel Segal <er...@gmail.com> wrote:
>
> > This is great, thank you!
> >
> > I think figure 3 is missing.
> >
> >
> > 2008/7/1, Gonzalo Aune <go...@gmail.com>:
> > >
> > > You can take a look at this guide:
> > > http://rajdeep.dua.googlepages.com/shindigPHP-overview-tidy_img.html
> > >
> > >
> > > G.-
> > >
> > >
> > > On Tue, Jul 1, 2008 at 10:31 AM, Erel Segal <er...@gmail.com> wrote:
> > >
> > > > OK. Is there already some external documentation to the PHP source
> code
> > > > (e.g. explaining what classes there are , what each class does,
> etc...)
> > > >
> > > > 2008/7/1, Gonzalo Aune <go...@gmail.com>:
> > > > >
> > > > > Of course!!, all help is very much appreciated, thanks Erel!
> > > > >
> > > > >
> > > > > G.-
> > > > >
> > > > >
> > > > > On Tue, Jul 1, 2008 at 10:08 AM, Erel Segal <er...@gmail.com>
> > wrote:
> > > > >
> > > > > > I began reading the PHP source code, and while trying to
> understand
> > > it,
> > > > I
> > > > > > made some changes and additions to the internal documentation. Is
> > it
> > > > > > worthwhile to submit these changes as patches, to help other
> > newbies
> > > > like
> > > > > > me?
> > > > > >
> > > > >
> > > >
> > >
> >
>
Re: documentation patches
Posted by Gonzalo Aune <go...@gmail.com>.
Which one?, i can see all of them.
G.-
On Tue, Jul 1, 2008 at 12:54 PM, Erel Segal <er...@gmail.com> wrote:
> This is great, thank you!
>
> I think figure 3 is missing.
>
>
> 2008/7/1, Gonzalo Aune <go...@gmail.com>:
> >
> > You can take a look at this guide:
> > http://rajdeep.dua.googlepages.com/shindigPHP-overview-tidy_img.html
> >
> >
> > G.-
> >
> >
> > On Tue, Jul 1, 2008 at 10:31 AM, Erel Segal <er...@gmail.com> wrote:
> >
> > > OK. Is there already some external documentation to the PHP source code
> > > (e.g. explaining what classes there are , what each class does, etc...)
> > >
> > > 2008/7/1, Gonzalo Aune <go...@gmail.com>:
> > > >
> > > > Of course!!, all help is very much appreciated, thanks Erel!
> > > >
> > > >
> > > > G.-
> > > >
> > > >
> > > > On Tue, Jul 1, 2008 at 10:08 AM, Erel Segal <er...@gmail.com>
> wrote:
> > > >
> > > > > I began reading the PHP source code, and while trying to understand
> > it,
> > > I
> > > > > made some changes and additions to the internal documentation. Is
> it
> > > > > worthwhile to submit these changes as patches, to help other
> newbies
> > > like
> > > > > me?
> > > > >
> > > >
> > >
> >
>
Re: documentation patches
Posted by Erel Segal <er...@gmail.com>.
This is great, thank you!
I think figure 3 is missing.
2008/7/1, Gonzalo Aune <go...@gmail.com>:
>
> You can take a look at this guide:
> http://rajdeep.dua.googlepages.com/shindigPHP-overview-tidy_img.html
>
>
> G.-
>
>
> On Tue, Jul 1, 2008 at 10:31 AM, Erel Segal <er...@gmail.com> wrote:
>
> > OK. Is there already some external documentation to the PHP source code
> > (e.g. explaining what classes there are , what each class does, etc...)
> >
> > 2008/7/1, Gonzalo Aune <go...@gmail.com>:
> > >
> > > Of course!!, all help is very much appreciated, thanks Erel!
> > >
> > >
> > > G.-
> > >
> > >
> > > On Tue, Jul 1, 2008 at 10:08 AM, Erel Segal <er...@gmail.com> wrote:
> > >
> > > > I began reading the PHP source code, and while trying to understand
> it,
> > I
> > > > made some changes and additions to the internal documentation. Is it
> > > > worthwhile to submit these changes as patches, to help other newbies
> > like
> > > > me?
> > > >
> > >
> >
>
Re: documentation patches
Posted by Gonzalo Aune <go...@gmail.com>.
You can take a look at this guide:
http://rajdeep.dua.googlepages.com/shindigPHP-overview-tidy_img.html
G.-
On Tue, Jul 1, 2008 at 10:31 AM, Erel Segal <er...@gmail.com> wrote:
> OK. Is there already some external documentation to the PHP source code
> (e.g. explaining what classes there are , what each class does, etc...)
>
> 2008/7/1, Gonzalo Aune <go...@gmail.com>:
> >
> > Of course!!, all help is very much appreciated, thanks Erel!
> >
> >
> > G.-
> >
> >
> > On Tue, Jul 1, 2008 at 10:08 AM, Erel Segal <er...@gmail.com> wrote:
> >
> > > I began reading the PHP source code, and while trying to understand it,
> I
> > > made some changes and additions to the internal documentation. Is it
> > > worthwhile to submit these changes as patches, to help other newbies
> like
> > > me?
> > >
> >
>
Re: documentation patches
Posted by Erel Segal <er...@gmail.com>.
OK. Is there already some external documentation to the PHP source code
(e.g. explaining what classes there are , what each class does, etc...)
2008/7/1, Gonzalo Aune <go...@gmail.com>:
>
> Of course!!, all help is very much appreciated, thanks Erel!
>
>
> G.-
>
>
> On Tue, Jul 1, 2008 at 10:08 AM, Erel Segal <er...@gmail.com> wrote:
>
> > I began reading the PHP source code, and while trying to understand it, I
> > made some changes and additions to the internal documentation. Is it
> > worthwhile to submit these changes as patches, to help other newbies like
> > me?
> >
>
Re: documentation patches
Posted by Gonzalo Aune <go...@gmail.com>.
Of course!!, all help is very much appreciated, thanks Erel!
G.-
On Tue, Jul 1, 2008 at 10:08 AM, Erel Segal <er...@gmail.com> wrote:
> I began reading the PHP source code, and while trying to understand it, I
> made some changes and additions to the internal documentation. Is it
> worthwhile to submit these changes as patches, to help other newbies like
> me?
>
Re: documentation patches
Posted by Chris Chabot <ch...@xs4all.nl>.
absolutely!
On Jul 1, 2008, at 3:08 PM, Erel Segal wrote:
> I began reading the PHP source code, and while trying to understand
> it, I
> made some changes and additions to the internal documentation. Is it
> worthwhile to submit these changes as patches, to help other newbies
> like
> me?