[pulsar] branch master updated: Fixed admin-api-non-persistent-topics documentation (#3781)

[si...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

sijie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git


The following commit(s) were added to refs/heads/master by this push:
     new e283940  Fixed admin-api-non-persistent-topics documentation (#3781)
e283940 is described below

commit e283940d00f25784b248a9d04b2baea4983b03b5
Author: David Kjerrumgaard <35...@users.noreply.github.com>
AuthorDate: Mon Mar 11 01:26:25 2019 -0700

    Fixed admin-api-non-persistent-topics documentation (#3781)
    
    Fixes #3780
    
    
    ### Motivation
    
    Update the documentation to more accurately reflect the condition of the queue when the availablePermits value is negative. The current documentation indicates that condition means the consumer is ready to receive more messages, when, in fact, it is NOT.
    
    ### Modifications
    
    Updated the http://pulsar.apache.org/docs/en/admin-api-non-persistent-topics.html#get-stats page
---
 site2/docs/admin-api-non-persistent-topics.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/site2/docs/admin-api-non-persistent-topics.md b/site2/docs/admin-api-non-persistent-topics.md
index bf3fdd1..20006da 100644
--- a/site2/docs/admin-api-non-persistent-topics.md
+++ b/site2/docs/admin-api-non-persistent-topics.md
@@ -52,7 +52,7 @@ It shows current statistics of a given non-partitioned topic.
 
   -   **consumerName**: Internal identifier for this consumer, generated by the client library
 
-  -   **availablePermits**: The number of messages this consumer has space for in the client library's listen queue. A value of 0 means the client library's queue is full and receive() isn't being called. A nonzero value means this consumer is ready to be dispatched messages.
+  -   **availablePermits**: The number of messages this consumer has space for in the client library's listen queue. A value less than 1 means the client library's queue is full and receive() isn't being called. A non-negative value means this consumer is ready to be dispatched messages.
 
   -   **replication**: This section gives the stats for cross-colo replication of this topic