Skip to content

update app config doc #7618

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xiangyan99 merged 2 commits into from
Oct 5, 2019
Merged

update app config doc #7618

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c68559c
update app config doc
xiangyan99 Oct 4, 2019
7fc7c7b
move match_condition to internal
xiangyan99 Oct 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 6 additions & 14 deletions doc/sphinx/ref/azure.appconfiguration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,26 +19,18 @@ azure.appconfiguration.azure\_appconfiguration\_client module
:undoc-members:
:show-inheritance:

azure.appconfiguration.azure\_appconfiguration\_requests module
---------------------------------------------------------------
azure.appconfiguration.azure\_appconfiguration\_credential module
-----------------------------------------------------------------
Copy link
Contributor

@bryevdv bryevdv Oct 4, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's up with the \? Is that something specific to our sphinx setup? I have never had to do this in other projects where there were module names with underscores.

Copy link
Member Author

@xiangyan99 xiangyan99 Oct 4, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'\' is used in sphinx to escape '_'. The full name of the module is
azure.appconfiguration.azure_appconfiguration_requests

Copy link
Contributor

@bryevdv bryevdv Oct 4, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, my confusion is that I've never known underscores to ever need escaping before :) e.g.

https://raw.githubusercontent.com/bokeh/bokeh/master/sphinx/source/docs/reference/tile_providers.rst

(with no escapes for underscores) generates

http://docs.bokeh.org/en/latest/docs/reference/tile_providers.html

Copy link
Member Author

@xiangyan99 xiangyan99 Oct 4, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is generated by the sphinx tool. :)


.. automodule:: azure.appconfiguration.azure_appconfiguration_requests
.. automodule:: azure.appconfiguration.azure_appconfiguration_credential
:members:
:undoc-members:
:show-inheritance:

azure.appconfiguration.utils module
-----------------------------------

.. automodule:: azure.appconfiguration.utils
:members:
:undoc-members:
:show-inheritance:

azure.appconfiguration.version module
-------------------------------------
azure.appconfiguration.azure\_appconfiguration\_requests module
---------------------------------------------------------------

.. automodule:: azure.appconfiguration.version
.. automodule:: azure.appconfiguration.azure_appconfiguration_requests
:members:
:undoc-members:
:show-inheritance:
Expand Down
3 changes: 1 addition & 2 deletions ...ion/azure-appconfiguration/azure/appconfiguration/aio/azure_configuration_client_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@
from requests.structures import CaseInsensitiveDict
from azure.core import MatchConditions
from azure.core.pipeline import AsyncPipeline
from azure.core.pipeline.policies import UserAgentPolicy
from azure.core.pipeline.policies import UserAgentPolicy, DistributedTracingPolicy
from azure.core.tracing.decorator import distributed_trace
from azure.core.tracing.decorator_async import distributed_trace_async
from azure.core.pipeline.policies.distributed_tracing import DistributedTracingPolicy
from azure.core.pipeline.transport import AsyncioRequestsTransport
from azure.core.exceptions import (
ResourceExistsError,
Expand Down
3 changes: 1 addition & 2 deletions ...figuration/azure-appconfiguration/azure/appconfiguration/azure_appconfiguration_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@
from requests.structures import CaseInsensitiveDict
from azure.core import MatchConditions
from azure.core.pipeline import Pipeline
from azure.core.pipeline.policies import UserAgentPolicy
from azure.core.pipeline.policies.distributed_tracing import DistributedTracingPolicy
from azure.core.pipeline.policies import UserAgentPolicy, DistributedTracingPolicy
from azure.core.tracing.decorator import distributed_trace
from azure.core.pipeline.transport import RequestsTransport
from azure.core.exceptions import (
Expand Down
2 changes: 1 addition & 1 deletion sdk/core/azure-core/azure/core/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
from .pipeline_client import PipelineClient
from .pipeline.transport import HttpRequest
from .exceptions import HttpResponseError
from .match_conditions import MatchConditions
from ._match_conditions import MatchConditions


__all__ = [
Expand Down
0 ...azure-core/azure/core/match_conditions.py → ...zure-core/azure/core/_match_conditions.py
View file
Open in desktop
File renamed without changes.