[doc] Update glossary link to grpc_arg_keys (#34771)

I have created an [issue on grpc.io
repository](https://github.com/grpc/grpc.io/issues/1212), and they have
pointed me towards this repository.

Currently, in the Python documentation glossary, the [channel
arguments](https://grpc.github.io/grpc/python/glossary.html#term-channel_arguments)
section contains a link to [header file
grpc_types.h](https://github.com/grpc/grpc/blob/v1.58.x/include/grpc/impl/codegen/grpc_types.h)
which is almost empty, and doesn't contain relevant information.

This PR fixes the invalid link in the Python glossary of gRPC
documentation, by replacing it with
[channel_arg_names.h](https://github.com/grpc/grpc/blob/v1.58.x/include/grpc/impl/channel_arg_names.h)
which contains the relevant information.
pull/34837/head
paskozdilar 1 year ago committed by GitHub
parent 433cfa99a5
commit 5b3da1a630
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 2
      doc/python/sphinx/conf.py
  2. 7
      doc/python/sphinx/glossary.rst

@ -107,4 +107,4 @@ todo_include_todos = True
# -- Options for substitutions ----------------------------------------------- # -- Options for substitutions -----------------------------------------------
rst_epilog = '.. |grpc_types_link| replace:: https://github.com/grpc/grpc/blob/%s/include/grpc/impl/codegen/grpc_types.h' % branch rst_epilog = '.. |channel_arg_names_link| replace:: https://github.com/grpc/grpc/blob/%s/include/grpc/impl/channel_arg_names.h' % branch

@ -45,6 +45,7 @@ Glossary
server object. Channel arguments are meant for advanced usages and contain server object. Channel arguments are meant for advanced usages and contain
experimental API (some may not labeled as experimental). Full list of experimental API (some may not labeled as experimental). Full list of
available channel arguments and documentation can be found under the available channel arguments and documentation can be found under the
"grpc_arg_keys" section of "grpc_types.h" header file (|grpc_types_link|). "grpc_arg_keys" section of "channel_arg_names.h" header file
For example, if you want to disable TCP port reuse, you may construct (|channel_arg_names_link|). For example, if you want to disable TCP port
channel arguments like: ``options = (('grpc.so_reuseport', 0),)``. reuse, you may construct channel arguments like:
``options = (('grpc.so_reuseport', 0),)``.

Loading…
Cancel
Save