Ticket #3216 defect closed fixed

Opened 5 years ago

Last modified 5 years ago

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
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

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

Change History

Changed 5 years ago by proppy

patch for amp.py docstring

1

Changed 5 years ago by exarkun

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

2

Changed 5 years ago by thijs

  • owner changed from glyph to thijs
  • cc thijs added
  • status changed from new to assigned
  • keywords documentation added

3

Changed 5 years ago by thijs

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

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

4

Changed 5 years ago by thijs

  • status changed from assigned to new
  • owner thijs deleted
  • keywords documentation, review added; documentation removed

Up for review, see r25124

5

Changed 5 years ago by exarkun

  • keywords documentation added; documentation, review removed
  • status changed from new to assigned
  • owner set to exarkun

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

6

Changed 5 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

7

Changed 5 years ago by exarkun

(In [25131]) NUL is not code

refs #3216

8

Changed 5 years ago by exarkun

(In [25132]) expound

refs #3216

9

Changed 5 years ago by exarkun

  • status changed from assigned to new
  • keywords documentation, review added; documentation removed
  • owner exarkun deleted
  • cc exarkun added
  • author changed from thijs to thijs, exarkun

Okay, looks good to me now. :)

10

Changed 5 years ago by thijs

  • owner set to thijs
  • status changed from new to assigned
  • keywords documentation added; documentation, review removed

Looks good, will merge it now.

11

Changed 5 years ago by thijs

  • owner thijs deleted
  • keywords documentation, review added; documentation removed
  • status changed from assigned to new

12

Changed 5 years ago by glyph

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

13

Changed 5 years ago by exarkun

  • cc glyph added

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

14

Changed 5 years ago by therve

  • keywords documentation added; documentation, review removed
  • owner set to exarkun

Please merge.

15

Changed 5 years ago by exarkun

  • status changed from new to closed
  • resolution set to fixed

(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.

16

Changed 2 years ago by <automation>

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