You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2021/06/20 01:20:10 UTC

[GitHub] [pulsar] fengtao1998 opened a new pull request #10984: [Docs]Update docs for Client libraries Python

fengtao1998 opened a new pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984


   
   ### Motivation
   
   Revise official documents to make them easy to understand and use
   
   ### Modifications
   
   - Correction of incorrect document
   - Add hyperlink jump for file
   - Correct inappropriate punctuation
   - Correction output
   
   
   ### Does this pull request potentially affect one of the following parts:
   
   *If `yes` was chosen, please highlight the changes*
   
     - Dependencies (does it add or upgrade a dependency): ( no)
     - The public API: (no)
     - The schema: ( no )
     - The default values of configurations: ( no)
     - The wire protocol: (no)
     - The rest endpoints: (no)
     - The admin cli options: (no)
     - Anything that affects deployment: (no)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] fengtao1998 commented on a change in pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
fengtao1998 commented on a change in pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984#discussion_r655828390



##########
File path: site2/docs/client-libraries-python.md
##########
@@ -62,7 +62,7 @@ The complete Python API reference is available at [api/python](/api/python).
 
 ## Examples
 
-You can find a variety of Python code examples for the `pulsar-client` library.
+You can find a variety of Python code examples for the [pulsar-client](/pulsar-client-cpp/python) library.

Review comment:
       In the following examples are /pulsar-client-cpp/python/test_consumer.py and /pulsar-client-cpp/python/test_test_producer.py, so I don't think it's necessary to change it here。Or we should move these two files to /examples
   
   
   
   




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] Jennifer88huang merged pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
Jennifer88huang merged pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] Anonymitaet commented on pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984#issuecomment-864707208


   @fengtao1998 thanks for your contribution. Does this affect only master or other versioned docs? 
   If latter, could you please help update all affected versions? Thanks


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] fengtao1998 commented on pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
fengtao1998 commented on pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984#issuecomment-894890012


   @Jennifer88huang  PTAL


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] BewareMyPower commented on a change in pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on a change in pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984#discussion_r655280679



##########
File path: site2/docs/client-libraries-python.md
##########
@@ -4,15 +4,15 @@ title: Pulsar Python client
 sidebar_label: Python
 ---
 
-Pulsar Python client library is a wrapper over the existing [C++ client library](client-libraries-cpp.md) and exposes all of the [same features](/api/cpp). You can find the code in the [`python` subdirectory](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python) of the C++ client code.
+Pulsar Python client library is a wrapper over the existing [C++ client library](client-libraries-cpp.md) and exposes all of the [same features](/api/cpp). You can find the code in the [`python` ](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python)subdirectory of the C++ client code.
 
 All the methods in producer, consumer, and reader of a Python client are thread-safe.
 
 [pdoc](https://github.com/BurntSushi/pdoc)-generated API docs for the Python client are available [here](/api/python).
 
 ## Install
 
-You can install the [`pulsar-client`](https://pypi.python.org/pypi/pulsar-client) library either via [PyPi](https://pypi.python.org/pypi), using [pip](#installation-using-pip), or by building the library from source.
+You can install the [`pulsar-client`](https://pypi.python.org/pypi/pulsar-client) library either via [PyPi](https://pypi.python.org/pypi), using [pip](#installation-using-pip), or by building the library from [source](https://github.com/apache/pulsar).

Review comment:
       It's better to use https://github.com/apache/pulsar/tree/master/pulsar-client-cpp as the link of source because Python client is built on C++ source code.

##########
File path: site2/docs/client-libraries-python.md
##########
@@ -62,7 +62,7 @@ The complete Python API reference is available at [api/python](/api/python).
 
 ## Examples
 
-You can find a variety of Python code examples for the `pulsar-client` library.
+You can find a variety of Python code examples for the [pulsar-client](/pulsar-client-cpp/python) library.

Review comment:
       ```suggestion
   You can find a variety of Python code examples for the [pulsar-client](/pulsar-client-cpp/python/examples) library.
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] Anonymitaet commented on pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984#issuecomment-865468050


   @fengtao1998 can you take a look at suggestions and resolve them as needed?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] fengtao1998 commented on a change in pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
fengtao1998 commented on a change in pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984#discussion_r655828390



##########
File path: site2/docs/client-libraries-python.md
##########
@@ -62,7 +62,7 @@ The complete Python API reference is available at [api/python](/api/python).
 
 ## Examples
 
-You can find a variety of Python code examples for the `pulsar-client` library.
+You can find a variety of Python code examples for the [pulsar-client](/pulsar-client-cpp/python) library.

Review comment:
       In the following examples are /pulsar-client-cpp/python/test_consumer.py and /pulsar-client-cpp/python/test_test_producer.py, soI don't think it's necessary to change it here。Or we should move these two files to /examples
   
   
   
   




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] fengtao1998 commented on pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
fengtao1998 commented on pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984#issuecomment-865484229


   > @fengtao1998 can you take a look at suggestions and resolve them as needed?
   
   Sorry for the delay. I have revised these suggestions. Thank you for your suggestion


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] tuteng commented on a change in pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
tuteng commented on a change in pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984#discussion_r681380155



##########
File path: site2/docs/client-libraries-python.md
##########
@@ -401,5 +401,5 @@ This section provides step-by-step instructions on how to use the end-to-end enc
     This is from the consumer side.
 
     ```
-    Received msg 'b'encryption message'' id = '(0,0,-1,-1)'
+    Received msg 'encryption message' id = '(0,0,-1,-1)'

Review comment:
       I think that's ok




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] Anonymitaet commented on a change in pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984#discussion_r655026081



##########
File path: site2/docs/client-libraries-python.md
##########
@@ -4,15 +4,15 @@ title: Pulsar Python client
 sidebar_label: Python
 ---
 
-Pulsar Python client library is a wrapper over the existing [C++ client library](client-libraries-cpp.md) and exposes all of the [same features](/api/cpp). You can find the code in the [`python` subdirectory](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python) of the C++ client code.
+Pulsar Python client library is a wrapper over the existing [C++ client library](client-libraries-cpp.md) and exposes all of the [same features](/api/cpp). You can find the code in the [`python` ](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python)subdirectory of the C++ client code.
 
 All the methods in producer, consumer, and reader of a Python client are thread-safe.
 
 [pdoc](https://github.com/BurntSushi/pdoc)-generated API docs for the Python client are available [here](/api/python).
 
 ## Install
 
-You can install the [`pulsar-client`](https://pypi.python.org/pypi/pulsar-client) library either via [PyPi](https://pypi.python.org/pypi), using [pip](#installation-using-pip), or by building the library from source.
+You can install the [`pulsar-client`](https://pypi.python.org/pypi/pulsar-client) library either via [PyPi](https://pypi.python.org/pypi), using [pip](#installation-using-pip), or by building the library from [source](https://github.com/apache/pulsar).

Review comment:
       ```suggestion
   You can install the [`pulsar-client`](https://pypi.python.org/pypi/pulsar-client) library either via [PyPi](https://pypi.python.org/pypi), using [pip](#installation-using-pip), or by building the library from [source](https://github.com/apache/pulsar/releases).
   ```

##########
File path: site2/docs/client-libraries-python.md
##########
@@ -4,15 +4,15 @@ title: Pulsar Python client
 sidebar_label: Python
 ---
 
-Pulsar Python client library is a wrapper over the existing [C++ client library](client-libraries-cpp.md) and exposes all of the [same features](/api/cpp). You can find the code in the [`python` subdirectory](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python) of the C++ client code.
+Pulsar Python client library is a wrapper over the existing [C++ client library](client-libraries-cpp.md) and exposes all of the [same features](/api/cpp). You can find the code in the [`python` ](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python)subdirectory of the C++ client code.

Review comment:
       ```suggestion
   Pulsar Python client library is a wrapper over the existing [C++ client library](client-libraries-cpp.md) and exposes all of the [same features](/api/cpp). You can find the code in the [Python subdirectory](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python)subdirectory of the C++ client code.
   ```

##########
File path: site2/docs/client-libraries-python.md
##########
@@ -401,5 +401,5 @@ This section provides step-by-step instructions on how to use the end-to-end enc
     This is from the consumer side.
 
     ```
-    Received msg 'b'encryption message'' id = '(0,0,-1,-1)'
+    Received msg 'encryption message' id = '(0,0,-1,-1)'

Review comment:
       @tuteng can u PTAL?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] fengtao1998 commented on a change in pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
fengtao1998 commented on a change in pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984#discussion_r655828390



##########
File path: site2/docs/client-libraries-python.md
##########
@@ -62,7 +62,7 @@ The complete Python API reference is available at [api/python](/api/python).
 
 ## Examples
 
-You can find a variety of Python code examples for the `pulsar-client` library.
+You can find a variety of Python code examples for the [pulsar-client](/pulsar-client-cpp/python) library.

Review comment:
       In the following examples are /pulsar-client-cpp/python/test_consumer.py and /pulsar-client-cpp/python/test_test_producer.py, soI don't think it's necessary to change it here。Or we should move these two files to /examples
   
   
   
   

##########
File path: site2/docs/client-libraries-python.md
##########
@@ -62,7 +62,7 @@ The complete Python API reference is available at [api/python](/api/python).
 
 ## Examples
 
-You can find a variety of Python code examples for the `pulsar-client` library.
+You can find a variety of Python code examples for the [pulsar-client](/pulsar-client-cpp/python) library.

Review comment:
       In the following examples are /pulsar-client-cpp/python/test_consumer.py and /pulsar-client-cpp/python/test_test_producer.py, so I don't think it's necessary to change it here。Or we should move these two files to /examples
   
   
   
   




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] Jennifer88huang commented on a change in pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
Jennifer88huang commented on a change in pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984#discussion_r681361976



##########
File path: site2/docs/client-libraries-python.md
##########
@@ -4,15 +4,15 @@ title: Pulsar Python client
 sidebar_label: Python
 ---
 
-Pulsar Python client library is a wrapper over the existing [C++ client library](client-libraries-cpp.md) and exposes all of the [same features](/api/cpp). You can find the code in the [`python` subdirectory](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python) of the C++ client code.
+Pulsar Python client library is a wrapper over the existing [C++ client library](client-libraries-cpp.md) and exposes all of the [same features](/api/cpp). You can find the code in the [Python subdirectory](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python) of the C++ client code.
 
 All the methods in producer, consumer, and reader of a Python client are thread-safe.
 
 [pdoc](https://github.com/BurntSushi/pdoc)-generated API docs for the Python client are available [here](/api/python).
 
 ## Install
 
-You can install the [`pulsar-client`](https://pypi.python.org/pypi/pulsar-client) library either via [PyPi](https://pypi.python.org/pypi), using [pip](#installation-using-pip), or by building the library from source.
+You can install the [`pulsar-client`](https://pypi.python.org/pypi/pulsar-client) library either via [PyPi](https://pypi.python.org/pypi), using [pip](#installation-using-pip), or by building the library from [source](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp).
 
 ### Install using pip

Review comment:
       It gives two options:
   - Install using pip
   - Install from source
   




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] Anonymitaet commented on pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984#issuecomment-865468050


   @fengtao1998 can you take a look at suggestions and resolve them as needed?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] BewareMyPower commented on a change in pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on a change in pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984#discussion_r655280679



##########
File path: site2/docs/client-libraries-python.md
##########
@@ -4,15 +4,15 @@ title: Pulsar Python client
 sidebar_label: Python
 ---
 
-Pulsar Python client library is a wrapper over the existing [C++ client library](client-libraries-cpp.md) and exposes all of the [same features](/api/cpp). You can find the code in the [`python` subdirectory](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python) of the C++ client code.
+Pulsar Python client library is a wrapper over the existing [C++ client library](client-libraries-cpp.md) and exposes all of the [same features](/api/cpp). You can find the code in the [`python` ](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python)subdirectory of the C++ client code.
 
 All the methods in producer, consumer, and reader of a Python client are thread-safe.
 
 [pdoc](https://github.com/BurntSushi/pdoc)-generated API docs for the Python client are available [here](/api/python).
 
 ## Install
 
-You can install the [`pulsar-client`](https://pypi.python.org/pypi/pulsar-client) library either via [PyPi](https://pypi.python.org/pypi), using [pip](#installation-using-pip), or by building the library from source.
+You can install the [`pulsar-client`](https://pypi.python.org/pypi/pulsar-client) library either via [PyPi](https://pypi.python.org/pypi), using [pip](#installation-using-pip), or by building the library from [source](https://github.com/apache/pulsar).

Review comment:
       It's better to use https://github.com/apache/pulsar/tree/master/pulsar-client-cpp as the link of source because Python client is built on C++ source code.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] sijia-w commented on a change in pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
sijia-w commented on a change in pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984#discussion_r680811283



##########
File path: site2/docs/client-libraries-python.md
##########
@@ -4,15 +4,15 @@ title: Pulsar Python client
 sidebar_label: Python
 ---
 
-Pulsar Python client library is a wrapper over the existing [C++ client library](client-libraries-cpp.md) and exposes all of the [same features](/api/cpp). You can find the code in the [`python` subdirectory](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python) of the C++ client code.
+Pulsar Python client library is a wrapper over the existing [C++ client library](client-libraries-cpp.md) and exposes all of the [same features](/api/cpp). You can find the code in the [Python subdirectory](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python) of the C++ client code.
 
 All the methods in producer, consumer, and reader of a Python client are thread-safe.
 
 [pdoc](https://github.com/BurntSushi/pdoc)-generated API docs for the Python client are available [here](/api/python).
 
 ## Install
 
-You can install the [`pulsar-client`](https://pypi.python.org/pypi/pulsar-client) library either via [PyPi](https://pypi.python.org/pypi), using [pip](#installation-using-pip), or by building the library from source.
+You can install the [`pulsar-client`](https://pypi.python.org/pypi/pulsar-client) library either via [PyPi](https://pypi.python.org/pypi), using [pip](#installation-using-pip), or by building the library from [source](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp).
 
 ### Install using pip

Review comment:
       If this guideline only gives an example with installation using pip, should we say it? I was expecting the installation examples using other methods.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] sijia-w commented on a change in pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
sijia-w commented on a change in pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984#discussion_r683342423



##########
File path: site2/docs/client-libraries-python.md
##########
@@ -4,15 +4,15 @@ title: Pulsar Python client
 sidebar_label: Python
 ---
 
-Pulsar Python client library is a wrapper over the existing [C++ client library](client-libraries-cpp.md) and exposes all of the [same features](/api/cpp). You can find the code in the [`python` subdirectory](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python) of the C++ client code.
+Pulsar Python client library is a wrapper over the existing [C++ client library](client-libraries-cpp.md) and exposes all of the [same features](/api/cpp). You can find the code in the [Python subdirectory](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python) of the C++ client code.
 
 All the methods in producer, consumer, and reader of a Python client are thread-safe.
 
 [pdoc](https://github.com/BurntSushi/pdoc)-generated API docs for the Python client are available [here](/api/python).
 
 ## Install
 
-You can install the [`pulsar-client`](https://pypi.python.org/pypi/pulsar-client) library either via [PyPi](https://pypi.python.org/pypi), using [pip](#installation-using-pip), or by building the library from source.
+You can install the [`pulsar-client`](https://pypi.python.org/pypi/pulsar-client) library either via [PyPi](https://pypi.python.org/pypi), using [pip](#installation-using-pip), or by building the library from [source](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp).
 
 ### Install using pip

Review comment:
       That's true. Thank you.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] BewareMyPower commented on a change in pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on a change in pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984#discussion_r655281335



##########
File path: site2/docs/client-libraries-python.md
##########
@@ -62,7 +62,7 @@ The complete Python API reference is available at [api/python](/api/python).
 
 ## Examples
 
-You can find a variety of Python code examples for the `pulsar-client` library.
+You can find a variety of Python code examples for the [pulsar-client](/pulsar-client-cpp/python) library.

Review comment:
       ```suggestion
   You can find a variety of Python code examples for the [pulsar-client](/pulsar-client-cpp/python/examples) library.
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] sijia-w commented on a change in pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
sijia-w commented on a change in pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984#discussion_r683342423



##########
File path: site2/docs/client-libraries-python.md
##########
@@ -4,15 +4,15 @@ title: Pulsar Python client
 sidebar_label: Python
 ---
 
-Pulsar Python client library is a wrapper over the existing [C++ client library](client-libraries-cpp.md) and exposes all of the [same features](/api/cpp). You can find the code in the [`python` subdirectory](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python) of the C++ client code.
+Pulsar Python client library is a wrapper over the existing [C++ client library](client-libraries-cpp.md) and exposes all of the [same features](/api/cpp). You can find the code in the [Python subdirectory](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python) of the C++ client code.
 
 All the methods in producer, consumer, and reader of a Python client are thread-safe.
 
 [pdoc](https://github.com/BurntSushi/pdoc)-generated API docs for the Python client are available [here](/api/python).
 
 ## Install
 
-You can install the [`pulsar-client`](https://pypi.python.org/pypi/pulsar-client) library either via [PyPi](https://pypi.python.org/pypi), using [pip](#installation-using-pip), or by building the library from source.
+You can install the [`pulsar-client`](https://pypi.python.org/pypi/pulsar-client) library either via [PyPi](https://pypi.python.org/pypi), using [pip](#installation-using-pip), or by building the library from [source](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp).
 
 ### Install using pip

Review comment:
       That's true. Thank you.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] tuteng commented on a change in pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
tuteng commented on a change in pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984#discussion_r681379639



##########
File path: site2/docs/client-libraries-python.md
##########
@@ -4,15 +4,15 @@ title: Pulsar Python client
 sidebar_label: Python
 ---
 
-Pulsar Python client library is a wrapper over the existing [C++ client library](client-libraries-cpp.md) and exposes all of the [same features](/api/cpp). You can find the code in the [`python` subdirectory](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python) of the C++ client code.
+Pulsar Python client library is a wrapper over the existing [C++ client library](client-libraries-cpp.md) and exposes all of the [same features](/api/cpp). You can find the code in the [Python subdirectory](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python) of the C++ client code.

Review comment:
       No `Python` subdirectory, only `python` subdirectory




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] sijia-w commented on pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
sijia-w commented on pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984#issuecomment-893363964


   LGTM


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] fengtao1998 commented on pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
fengtao1998 commented on pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984#issuecomment-865484229


   > @fengtao1998 can you take a look at suggestions and resolve them as needed?
   
   Sorry for the delay. I have revised these suggestions. Thank you for your suggestion


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] sijia-w commented on pull request #10984: [Docs]Update docs for Client libraries Python

Posted by GitBox <gi...@apache.org>.
sijia-w commented on pull request #10984:
URL: https://github.com/apache/pulsar/pull/10984#issuecomment-893363964


   LGTM


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org