[
https://issues.apache.org/jira/browse/DERBY-6830?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Rick Hillegas updated DERBY-6830:
---------------------------------
Attachment: derby-6830-01-ab-refguide.diff
Thanks for the review comments, Bryan. I am attaching a second rev of the
patch, derby-6830-01-ab-refguide.diff, which changes the summary for
stddev_pop() to the following, as you suggested:
"STDDEV_POP is an aggregate function that evaluates the standard deviation of
an expression over a population."
Otherwise the two versions of the patch are identical. Some responses below...
BP> I suppose that the abbreviations "pop" => "population", "samp" => "sample",
BP> "var" => "variance", and "stddev" => "standard deviation" are fairly well
BP> known to statisticians (I am not one such)?
I'm not a statistician either. My sense is that the terms population, sample,
variance, and standard deviation are well understood by statisticians. I think
that a statistician would understand what these aggregates do after reading
these reference pages. However, I share your concern that statisticians might
be puzzled by the abbreviated names which the SQL Standard chose for these
aggregates.
BP>
BP> I wonder if there is a place in our documentation for a glossary entry that
BP> makes those abbreviations more obvious? Or some sort of indexing?
I'm open to suggestions. We have talked about indexing the docs on many
previous occasions. The docs contain lots of markup for index terms, left over
from the original Cloudscape doc set. So generating an index just means running
a program over the existing dita source. Unfortunately, we always get stuck on
the deficiencies of our doc compiler. It can't generate a master index from the
markup.
BP>
BP> Beyond that abstract comment, the only other thing I noticed was that
BP> the description of STDDEV_POP didn't actually use the word "population"
BP> in its description, while all the other functions included their complete
BP> terms (variance/sample/population/standard deviation) in their description.
BP>
BP> Does that indicate that this description is slightly inadequate (should say
BP> "population" in it somewhere)?
BP>
BP> +<shortdesc>STDDEV_POP is an aggregate function that evaluates the
BP> + standard deviation of an expression over a set of rows.</shortdesc>
Thanks. Hopefully the second rev of the patch improves this wording.
Thanks,
-Rick
> Add user documentation for var_pop(), var_samp(), stddev_pop(), and
> stddev_samp()
> ---------------------------------------------------------------------------------
>
> Key: DERBY-6830
> URL: https://issues.apache.org/jira/browse/DERBY-6830
> Project: Derby
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 10.12.0.0
> Reporter: Rick Hillegas
> Assignee: Rick Hillegas
> Attachments: derby-6830-01-aa-refguide.diff,
> derby-6830-01-aa-refguide.tar, derby-6830-01-ab-refguide.diff
>
>
> Add user documentation for the new aggregates added by DERBY-5466.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
