Opened 6 years ago

Closed 6 years ago

#3216 defect closed fixed (fixed)

twisted.amp documentation _command and _ask order inverted

Reported by: proppy Owned by:
Priority: normal Milestone:
Component: core Keywords: documentation
Cc: thijs, exarkun, glyph Branch: branches/amp-keys-doc-3216
(diff, github, buildbot, log)
Author: thijs, exarkun Launchpad Bug:

Description

This documentation page: http://twistedmatrix.com/documents/current/api/twisted.protocols.amp.html

Lists amp keys in the following order:

C: _command: sum
C: _ask: ef639e5c892ccb54

However when reading raw amp data from C++:
http://proppy.aminche.com/hg/boost-asio-sample/file/f58a19591ee5/client.cpp

I received data in this order:

_ask
8
_command
MessageReceived
message
ping

Attachments (1)

twisted-amp-doc-ask-command-inverted.patch (409 bytes) - added by proppy 6 years ago.
patch for amp.py docstring

Download all attachments as: .zip

Change History (17)

Changed 6 years ago by proppy

patch for amp.py docstring

comment:1 Changed 6 years ago by exarkun

The relative order of _ask and _command is arbitrary. Perhaps the documentation should be updated to say this.

comment:2 Changed 6 years ago by thijs

  • Cc thijs added
  • Keywords documentation added
  • Owner changed from glyph to thijs
  • Status changed from new to assigned

comment:3 Changed 6 years ago by thijs

  • author set to thijs
  • Branch set to branches/amp-keys-doc-3216

(In [25123]) Branching to 'amp-keys-doc-3216'

comment:4 Changed 6 years ago by thijs

  • Keywords review added
  • Owner thijs deleted
  • Status changed from assigned to new

Up for review, see r25124

comment:5 Changed 6 years ago by exarkun

  • Keywords review removed
  • Owner set to exarkun
  • Status changed from new to assigned

There are some mistakes. I'm going to fix them.

comment:6 Changed 6 years ago by exarkun

(In [25130]) restore Divmod copyright statement

it may make sense to remove this and replace it with an entry in the LICENSE file

refs #3216

comment:7 Changed 6 years ago by exarkun

(In [25131]) NUL is not code

refs #3216

comment:8 Changed 6 years ago by exarkun

(In [25132]) expound

refs #3216

comment:9 Changed 6 years ago by exarkun

  • author changed from thijs to thijs, exarkun
  • Cc exarkun added
  • Keywords review added
  • Owner exarkun deleted
  • Status changed from assigned to new

Okay, looks good to me now. :)

comment:10 Changed 6 years ago by thijs

  • Keywords review removed
  • Owner set to thijs
  • Status changed from new to assigned

Looks good, will merge it now.

comment:11 Changed 6 years ago by thijs

  • Keywords review added
  • Owner thijs deleted
  • Status changed from assigned to new

comment:12 Changed 6 years ago by glyph

... why did this go from "will merge it now" to review?

comment:13 Changed 6 years ago by exarkun

  • Cc glyph added

It needs a review by someone who wasn't an author.

comment:14 Changed 6 years ago by therve

  • Keywords review removed
  • Owner set to exarkun

Please merge.

comment:15 Changed 6 years ago by exarkun

  • Resolution set to fixed
  • Status changed from new to closed

(In [25346]) Merge amp-keys-doc-3216

Author: thijs, exarkun
Reviewer: therve
Fixes: #3216

Clarify the amp box key ordering rules in the amp module docstring.

comment:16 Changed 3 years ago by <automation>

  • Owner exarkun deleted
Note: See TracTickets for help on using tickets.