db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Kim Haase (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (DERBY-6608) Confusing language in BLOB/CLOB Reference Manual topics
Date Wed, 11 Jun 2014 15:18:02 GMT

     [ https://issues.apache.org/jira/browse/DERBY-6608?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Kim Haase updated DERBY-6608:
-----------------------------

    Description: 
The BLOB topic, http://db.apache.org/derby/docs/10.10/ref/rrefblob.html, has a paragraph followed
by a note stating the following: 

{quote}
The length is given in bytes for BLOB unless one of the suffixes K, M, or G is given, relating
to the multiples of 1024, 1024*1024, 1024*1024*1024 respectively.

Note: Length is specified in bytes for BLOB.
{quote}

Why the note is necessary is not clear to me. Wouldn't it make sense to remove it and rewrite
the paragraph to say,

{quote}
The length is specified in bytes for BLOB unless one of the suffixes K, M, or G is given,
relating to the multiples of 1024, 1024*1024, 1024*1024*1024 respectively. If a suffix is
specified, the length is in kilobytes, megabytes, or gigabytes.
{quote}

The CLOB topic, http://db.apache.org/derby/docs/10.10/ref/rrefclob.html, is even more confusing:

{quote}
The length is given in number characters for both CLOB, unless one of the suffixes K, M, or
G is given, relating to the multiples of 1024, 1024*1024, 1024*1024*1024 respectively.

Length is specified in characters (unicode) for CLOB. 
{quote}

Would it be correct to say the following?

{quote}
The length is specified in numeric Unicode characters for CLOB unless one of the suffixes
K, M, or G is given, relating to the multiples of 1024, 1024*1024, 1024*1024*1024 respectively.
{quote}

I'm not sure how to express what the 1024 multiples are, though. Maybe it's not necessary
to do so.

  was:
The BLOB topic, http://db.apache.org/derby/docs/10.10/ref/rrefblob.html, has a paragraph followed
by a note stating the following: 

{blockquote}
The length is given in bytes for BLOB unless one of the suffixes K, M, or G is given, relating
to the multiples of 1024, 1024*1024, 1024*1024*1024 respectively.

Note: Length is specified in bytes for BLOB.
{blockquote}

Why the note is necessary is not clear to me. Wouldn't it make sense to remove it and rewrite
the paragraph to say,

{blockquote}
The length is specified in bytes for BLOB unless one of the suffixes K, M, or G is given,
relating to the multiples of 1024, 1024*1024, 1024*1024*1024 respectively. If a suffix is
specified, the length is in kilobytes, megabytes, or gigabytes.
{blockquote}

The CLOB topic, http://db.apache.org/derby/docs/10.10/ref/rrefclob.html, is even more confusing:

{blockquote}
The length is given in number characters for both CLOB, unless one of the suffixes K, M, or
G is given, relating to the multiples of 1024, 1024*1024, 1024*1024*1024 respectively.

Length is specified in characters (unicode) for CLOB. 
{blockquote}

Would it be correct to say the following?

{blockquote}
The length is specified in numeric Unicode characters for CLOB unless one of the suffixes
K, M, or G is given, relating to the multiples of 1024, 1024*1024, 1024*1024*1024 respectively.
{blockquote}

I'm not sure how to express what the 1024 multiples are, though. Maybe it's not necessary
to do so.


> Confusing language in BLOB/CLOB Reference Manual topics
> -------------------------------------------------------
>
>                 Key: DERBY-6608
>                 URL: https://issues.apache.org/jira/browse/DERBY-6608
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.10.2.0
>            Reporter: Kim Haase
>            Priority: Minor
>
> The BLOB topic, http://db.apache.org/derby/docs/10.10/ref/rrefblob.html, has a paragraph
followed by a note stating the following: 
> {quote}
> The length is given in bytes for BLOB unless one of the suffixes K, M, or G is given,
relating to the multiples of 1024, 1024*1024, 1024*1024*1024 respectively.
> Note: Length is specified in bytes for BLOB.
> {quote}
> Why the note is necessary is not clear to me. Wouldn't it make sense to remove it and
rewrite the paragraph to say,
> {quote}
> The length is specified in bytes for BLOB unless one of the suffixes K, M, or G is given,
relating to the multiples of 1024, 1024*1024, 1024*1024*1024 respectively. If a suffix is
specified, the length is in kilobytes, megabytes, or gigabytes.
> {quote}
> The CLOB topic, http://db.apache.org/derby/docs/10.10/ref/rrefclob.html, is even more
confusing:
> {quote}
> The length is given in number characters for both CLOB, unless one of the suffixes K,
M, or G is given, relating to the multiples of 1024, 1024*1024, 1024*1024*1024 respectively.
> Length is specified in characters (unicode) for CLOB. 
> {quote}
> Would it be correct to say the following?
> {quote}
> The length is specified in numeric Unicode characters for CLOB unless one of the suffixes
K, M, or G is given, relating to the multiples of 1024, 1024*1024, 1024*1024*1024 respectively.
> {quote}
> I'm not sure how to express what the 1024 multiples are, though. Maybe it's not necessary
to do so.



--
This message was sent by Atlassian JIRA
(v6.2#6252)

Mime
View raw message