Re: GSoD for 2020

On 04/16/2020 09:00 AM,
[email protected] wrote:

Subject:

Re: Reg: GSoD Applications for the year 2020

From:

PRUBHTEJ SINGH <[email protected]>

Date:

04/15/2020 12:26 PM

To:

Nicholas Jankowski <[email protected]>

CC:

octave-maintainers <[email protected]>

List-Post:

<mailto:[email protected]>

Precedence:

list

MIME-Version:

1.0

References:

<CAH1jWecSrj+zWvtG3rFcJ8HDQvRKH5F0=teP0t40CaT8Lw_9OA@mail.gmail.com>
<CABNpfR-=M2ohbkv6zc6+8wiV4nHSJaxhLU+KJqi=h4YcBcyaWA@mail.gmail.com>

In-Reply-To:

<CABNpfR-=M2ohbkv6zc6+8wiV4nHSJaxhLU+KJqi=h4YcBcyaWA@mail.gmail.com>

Message-ID:

<CAH1jWeeX+tx1Sk2uoApcCqGw+-Q49JOdO2G90z8R=hWLVTdQ=A@mail.gmail.com>

Content-Type:

multipart/alternative;
boundary="0000000000002bcc7005a3594ab0"

Message:

3

Thank you for your response.

Regards

Prubhtej singh

On Thu, Apr 16, 2020 at
12:55 AM Nicholas Jankowski <[email protected] >
wrote:

On Wed, Apr 15, 2020 at 3:05 PM PRUBHTEJ
SINGH <[email protected] >
wrote:

Greetings

I would like to enquire regarding the GSoD
2020, whether there are any opportunities
available with Octave for technical writing .

Regarding this and your previous inquiry, the
Octave maintainers have not had any online discussion
up to this point on participation in GSOD. (Your first
email was, I believe, in response to my Octave
maintainers list inquiry about whether there was any
interest in pursuing GSOD.)

If you are familiar with Octave and had ideas for a
GSOD appropriate Octave project, perhaps offering some
suggestions here might be a good way to prompt a
discussion.

There is a small list of documentation projects at
http://wiki.octave.org/Projects#Documentation_and_On-Line_Help .
But, the list is out of date and probably not what we would
concentrate on now. For example, it refers to "help -i" which isn't
even valid Octave syntax anymore.

One project would simply be to read various chapters of the manual
and see whether they make sense. A lot of the documentation was
written by developers, and we may think a concept is obvious, when
it is fact not.

Another idea would be looking at the documentation of individual
functions and re-writing any which doesn't use the standard
documentation template (I think there is a description in the Octave
Wiki about how functions should be documented).

--Rik