You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by dc...@apache.org on 2012/11/18 20:19:39 UTC
[4/6] git commit: Fix copy-paste typo,
remove changes history for request object.
Fix copy-paste typo, remove changes history for request object.
Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/56642eb7
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/56642eb7
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/56642eb7
Branch: refs/heads/docs
Commit: 56642eb7221ecfe1941013e495cf38f3d3504f0b
Parents: 3bba592
Author: Alexander Shorin <kx...@gmail.com>
Authored: Tue Nov 6 01:20:39 2012 +0400
Committer: Dave Cottlehuber <dc...@apache.org>
Committed: Sun Nov 18 20:17:55 2012 +0100
----------------------------------------------------------------------
share/doc/src/json-structure.rst | 11 -----------
1 files changed, 0 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/couchdb/blob/56642eb7/share/doc/src/json-structure.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/json-structure.rst b/share/doc/src/json-structure.rst
index f4fd4cc..7b998f9 100644
--- a/share/doc/src/json-structure.rst
+++ b/share/doc/src/json-structure.rst
@@ -349,10 +349,6 @@ Request object
| | (empty string) |
+--------------------------------+---------------------------------------------+
| cookie | Cookies `object`. |
-| | If request method is `GET` method contains |
-| | this field contains ``"undefined"`` value, |
-| | while if `DELETE` or `HEAD` value is ``""`` |
-| | (empty string). |
+--------------------------------+---------------------------------------------+
| form | Form data `object`. |
| | Contains decoded body as key-value pairs if |
@@ -392,13 +388,6 @@ Request object
| | config file. |
+--------------------------------+---------------------------------------------+
-.. versionadded:: 0.9.0
-.. versionchanged:: 0.10.0 Add ``userCtx`` field.
-.. versionchanged:: 0.11.0 Rename ``verb`` field to ``method``.
-.. versionchanged:: 0.11.0 Add ``id``, ``peer`` and ``uuid`` fields.
-.. versionchanged:: 1.1.0 Add ``requested_path`` and ``secObj`` fields.
-.. versionchanged:: 1.2.0 Add ``raw_path`` field.
-
.. code-block:: javascript
{
Re: [4/6] git commit: Fix copy-paste typo, remove changes history for
request object.
Posted by Alexander Shorin <kx...@gmail.com>.
On Mon, Dec 3, 2012 at 4:29 AM, Noah Slater <ns...@apache.org> wrote:
> Actually, Alexander. I think I stick by my original point. Even though we
> talked about only tracking information for 1.3 and onwards, doesn't it seem
> a bit silly to remove information that we already have?
I wouldn't protect this changes, but there should be clear policy: to
track history of all things or to track not it. If there exists
history about changes of Request object, probably we have to se tup
others too. If we have decided to track history since some point, it
should be base point to start counting from. The only matters question
"how deeper" I need to go for this history: for base objects and http
API I have drafts with changes tracks, it's not problem to undo revert
and add others. Just tell me that and I'll do it since I'm not sure
what really need to do.
> I guess I'm confused about what the purpose of this information is for. If
> this is the sort of thing that you'd actually want to know about as an end
> user. Say, you've just installed the latest and greatest, and you want to
> have things called out, then that makes sense. It would also be good to
> know what has been depreciated or depreciated. What else is this
> information good for?
This information helps to quick overview history of changes for older
releases without need to lookup their docs and/or reading their change
logs. While this information is special targeted for some
feature/object it's clearly may give answer about backward
compatibility. Say, I'd found `since=now` parameter support for
_changes feed in 1.3.0, but looks like it doesn't exists in older
releases => I need to care about workaround ways if I need to support
older CouchDB releases while using same feature. It's the best for
client developers and simplifies their life since they have to support
as much versions as it possible. Yes, there is global article "What's
new in 1.3.0" that describes all changes within single release, but
when you implementing some feature you'd like to see all possible
information about it at single page without noise.
--
,,,^..^,,,
Re: [4/6] git commit: Fix copy-paste typo, remove changes history for
request object.
Posted by Noah Slater <ns...@apache.org>.
Actually, Alexander. I think I stick by my original point. Even though we
talked about only tracking information for 1.3 and onwards, doesn't it seem
a bit silly to remove information that we already have?
I guess I'm confused about what the purpose of this information is for. If
this is the sort of thing that you'd actually want to know about as an end
user. Say, you've just installed the latest and greatest, and you want to
have things called out, then that makes sense. It would also be good to
know what has been depreciated or depreciated. What else is this
information good for?
On 2 December 2012 22:07, Alexander Shorin <kx...@gmail.com> wrote:
> On Mon, Dec 3, 2012 at 1:56 AM, Noah Slater <ns...@apache.org> wrote:
> > Why did you remove the change history? It seems useful.
>
> So was decided on one of meetings to track changes since 1.3 version,
> may be 1.2, not deeper:
> http://wiki.apache.org/couchdb/Meeting20121010#Doc_Versions
>
> --
> ,,,^..^,,,
>
--
NS
Re: [4/6] git commit: Fix copy-paste typo, remove changes history for request object.
Posted by Jan Lehnardt <ja...@apache.org>.
On Dec 3, 2012, at 01:26 , Noah Slater <ns...@apache.org> wrote:
> Thanks Alexander.
>
> Jan, I see what you're saying. But the purpose of the docs is to highlight
> key information for end users. Just like we don't complain about
> duplicating logic in the docs (consider the "just read the code" argument)
> I don't think we should complain about duplicating change history. But
> obviously, only when it is useful for end users. Who, let's face it, are
> not going to go poking around in Git to find out when some attribute or
> argument was changed. And if we do expect users to do this sort of thing,
> why bother with the docs at all?
I didn’t suggest to remove that information from the docs or that people
have to “poke around in git” (this really isn’t as bad as you make it
sound, btw), just that we track this information in a system designed to
do that as an artefact of us doing the changes, rather than doing it by
had. We can extract the relevant information out of git and splice them
into the final display version of the docs.
Cheers
Jan
--
>
>
>
> On 2 December 2012 22:07, Alexander Shorin <kx...@gmail.com> wrote:
>
>> On Mon, Dec 3, 2012 at 1:56 AM, Noah Slater <ns...@apache.org> wrote:
>>> Why did you remove the change history? It seems useful.
>>
>> So was decided on one of meetings to track changes since 1.3 version,
>> may be 1.2, not deeper:
>> http://wiki.apache.org/couchdb/Meeting20121010#Doc_Versions
>>
>> --
>> ,,,^..^,,,
>>
>
>
>
> --
> NS
Re: [4/6] git commit: Fix copy-paste typo, remove changes history for
request object.
Posted by Noah Slater <ns...@apache.org>.
Thanks Alexander.
Jan, I see what you're saying. But the purpose of the docs is to highlight
key information for end users. Just like we don't complain about
duplicating logic in the docs (consider the "just read the code" argument)
I don't think we should complain about duplicating change history. But
obviously, only when it is useful for end users. Who, let's face it, are
not going to go poking around in Git to find out when some attribute or
argument was changed. And if we do expect users to do this sort of thing,
why bother with the docs at all?
On 2 December 2012 22:07, Alexander Shorin <kx...@gmail.com> wrote:
> On Mon, Dec 3, 2012 at 1:56 AM, Noah Slater <ns...@apache.org> wrote:
> > Why did you remove the change history? It seems useful.
>
> So was decided on one of meetings to track changes since 1.3 version,
> may be 1.2, not deeper:
> http://wiki.apache.org/couchdb/Meeting20121010#Doc_Versions
>
> --
> ,,,^..^,,,
>
--
NS
Re: [4/6] git commit: Fix copy-paste typo, remove changes history for
request object.
Posted by Alexander Shorin <kx...@gmail.com>.
On Mon, Dec 3, 2012 at 1:56 AM, Noah Slater <ns...@apache.org> wrote:
> Why did you remove the change history? It seems useful.
So was decided on one of meetings to track changes since 1.3 version,
may be 1.2, not deeper:
http://wiki.apache.org/couchdb/Meeting20121010#Doc_Versions
--
,,,^..^,,,
Re: [4/6] git commit: Fix copy-paste typo, remove changes history for request object.
Posted by Jan Lehnardt <ja...@apache.org>.
On Dec 2, 2012, at 22:56 , Noah Slater <ns...@apache.org> wrote:
> Why did you remove the change history? It seems useful.
Mini-derail, as I can’t speak for Dave: regardless of the reason for
this one, we should try to keep version info in a VCS. Hand rolling
changes prone to errors and not-doing-it.
I do agree that being able to see historical information for docs
is useful.
Cheers
Jan
--
> On 18 November 2012 19:19, <dc...@apache.org> wrote:
>
>> Fix copy-paste typo, remove changes history for request object.
>>
>>
>> Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
>> Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/56642eb7
>> Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/56642eb7
>> Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/56642eb7
>>
>> Branch: refs/heads/docs
>> Commit: 56642eb7221ecfe1941013e495cf38f3d3504f0b
>> Parents: 3bba592
>> Author: Alexander Shorin <kx...@gmail.com>
>> Authored: Tue Nov 6 01:20:39 2012 +0400
>> Committer: Dave Cottlehuber <dc...@apache.org>
>> Committed: Sun Nov 18 20:17:55 2012 +0100
>>
>> ----------------------------------------------------------------------
>> share/doc/src/json-structure.rst | 11 -----------
>> 1 files changed, 0 insertions(+), 11 deletions(-)
>> ----------------------------------------------------------------------
>>
>>
>>
>> http://git-wip-us.apache.org/repos/asf/couchdb/blob/56642eb7/share/doc/src/json-structure.rst
>> ----------------------------------------------------------------------
>> diff --git a/share/doc/src/json-structure.rst
>> b/share/doc/src/json-structure.rst
>> index f4fd4cc..7b998f9 100644
>> --- a/share/doc/src/json-structure.rst
>> +++ b/share/doc/src/json-structure.rst
>> @@ -349,10 +349,6 @@ Request object
>> | | (empty string)
>> |
>>
>> +--------------------------------+---------------------------------------------+
>> | cookie | Cookies `object`.
>> |
>> -| | If request method is `GET` method
>> contains |
>> -| | this field contains ``"undefined"``
>> value, |
>> -| | while if `DELETE` or `HEAD` value is
>> ``""`` |
>> -| | (empty string).
>> |
>>
>> +--------------------------------+---------------------------------------------+
>> | form | Form data `object`.
>> |
>> | | Contains decoded body as key-value
>> pairs if |
>> @@ -392,13 +388,6 @@ Request object
>> | | config file.
>> |
>>
>> +--------------------------------+---------------------------------------------+
>>
>> -.. versionadded:: 0.9.0
>> -.. versionchanged:: 0.10.0 Add ``userCtx`` field.
>> -.. versionchanged:: 0.11.0 Rename ``verb`` field to ``method``.
>> -.. versionchanged:: 0.11.0 Add ``id``, ``peer`` and ``uuid`` fields.
>> -.. versionchanged:: 1.1.0 Add ``requested_path`` and ``secObj`` fields.
>> -.. versionchanged:: 1.2.0 Add ``raw_path`` field.
>> -
>> .. code-block:: javascript
>>
>> {
>>
>>
>
>
> --
> NS
Re: [4/6] git commit: Fix copy-paste typo, remove changes history for
request object.
Posted by Noah Slater <ns...@apache.org>.
Why did you remove the change history? It seems useful.
On 18 November 2012 19:19, <dc...@apache.org> wrote:
> Fix copy-paste typo, remove changes history for request object.
>
>
> Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
> Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/56642eb7
> Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/56642eb7
> Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/56642eb7
>
> Branch: refs/heads/docs
> Commit: 56642eb7221ecfe1941013e495cf38f3d3504f0b
> Parents: 3bba592
> Author: Alexander Shorin <kx...@gmail.com>
> Authored: Tue Nov 6 01:20:39 2012 +0400
> Committer: Dave Cottlehuber <dc...@apache.org>
> Committed: Sun Nov 18 20:17:55 2012 +0100
>
> ----------------------------------------------------------------------
> share/doc/src/json-structure.rst | 11 -----------
> 1 files changed, 0 insertions(+), 11 deletions(-)
> ----------------------------------------------------------------------
>
>
>
> http://git-wip-us.apache.org/repos/asf/couchdb/blob/56642eb7/share/doc/src/json-structure.rst
> ----------------------------------------------------------------------
> diff --git a/share/doc/src/json-structure.rst
> b/share/doc/src/json-structure.rst
> index f4fd4cc..7b998f9 100644
> --- a/share/doc/src/json-structure.rst
> +++ b/share/doc/src/json-structure.rst
> @@ -349,10 +349,6 @@ Request object
> | | (empty string)
> |
>
> +--------------------------------+---------------------------------------------+
> | cookie | Cookies `object`.
> |
> -| | If request method is `GET` method
> contains |
> -| | this field contains ``"undefined"``
> value, |
> -| | while if `DELETE` or `HEAD` value is
> ``""`` |
> -| | (empty string).
> |
>
> +--------------------------------+---------------------------------------------+
> | form | Form data `object`.
> |
> | | Contains decoded body as key-value
> pairs if |
> @@ -392,13 +388,6 @@ Request object
> | | config file.
> |
>
> +--------------------------------+---------------------------------------------+
>
> -.. versionadded:: 0.9.0
> -.. versionchanged:: 0.10.0 Add ``userCtx`` field.
> -.. versionchanged:: 0.11.0 Rename ``verb`` field to ``method``.
> -.. versionchanged:: 0.11.0 Add ``id``, ``peer`` and ``uuid`` fields.
> -.. versionchanged:: 1.1.0 Add ``requested_path`` and ``secObj`` fields.
> -.. versionchanged:: 1.2.0 Add ``raw_path`` field.
> -
> .. code-block:: javascript
>
> {
>
>
--
NS