yetus-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Allen Wittenauer (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (YETUS-80) update missing docs from Hadoop
Date Wed, 24 Aug 2016 15:17:22 GMT

    [ https://issues.apache.org/jira/browse/YETUS-80?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15435091#comment-15435091
] 

Allen Wittenauer commented on YETUS-80:
---------------------------------------


bq. There are several places where we have mentioned just Yetus, should I change those also
to Apache Yetus?

The key requirement here is that the first mention of Yetus should definitely be Apache Yetus.
 After that it becomes a matter of preference.  We should probably see if there is any consistency
with the rest of the docs.

Other comments:

* editing gone awry? "Yetus provides the following interface classification, this classification
was derived from the"

* other should be plural (i.e., others): "implementation, other are public" 

* This is grammatically and technically awkward: " in posix, libc is an external or public
interface, while large parts of the kernel are internal or private interfaces."

It's implying that POSIX is defining kernel interfaces (which it kind of is, but that's a
different set of arguments hahah). This should be rewritten such that "POSIX definitions in
libc are external" or something like that.

* missing a 'be': "could potentially removed"

* Remove(?) : How are the Classifications Recorded?

On a second reading, this section makes absolutely no sense as currently written.  It's basically
implying a bunch of stuff that isn't true because the user of the Yetus would need to add
the doclet to their javadoc setup, inform their users about how their documentation is generated,
etc, etc. I think it's reasonable to do that in a follow-up rather than bog this one down
with those details.



> update missing docs from Hadoop
> -------------------------------
>
>                 Key: YETUS-80
>                 URL: https://issues.apache.org/jira/browse/YETUS-80
>             Project: Yetus
>          Issue Type: Task
>          Components: website and documentation
>    Affects Versions: 0.1.0
>            Reporter: Sean Busbey
>            Assignee: Ajay Yadava
>         Attachments: YETUS-80.00.patch, YETUS-80.01.patch, YETUS-80.02.patch
>
>
> per [~aw] on YETUS-3:
> {quote}
> Add parts of the Hadoop's interface classification documentation into our docs. We need
this for shelldocs too (which currently lacks documentation).
> {quote}



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message