Skip to content

validate doc diffs #3314

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

Open
iscai-msft wants to merge 1 commit into
base: main
Choose a base branch
from
Open

validate doc diffs #3314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion packages/autorest.python/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
},
"homepage": "https://github.com/Azure/autorest.python/blob/main/README.md",
"dependencies": {
"@typespec/http-client-python": "~0.26.0",
"@typespec/http-client-python": "/Users/isabellacai/Desktop/github/typespec/packages/http-client-python/typespec-http-client-python-0.26.0.tgz",
"@autorest/system-requirements": "~1.0.2",
"fs-extra": "~11.2.0",
"tsx": "~4.19.1"
Expand Down
14 changes: 6 additions & 8 deletions ...itialVersionTolerant/dpgservicedriveninitialversiontolerant/aio/operations/_operations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ def __init__(self, *args, **kwargs) -> None:

@distributed_trace_async
async def head_no_params(self, **kwargs: Any) -> JSON:
"""Head request, no params.
Initially has no query parameters. After evolution, a new optional query parameter is added.
"""Head request, no params. Initially has no query parameters. After evolution, a new optional
query parameter is added.

:return: JSON
:rtype: JSON
Expand Down Expand Up @@ -106,9 +106,8 @@ async def head_no_params(self, **kwargs: Any) -> JSON:

@distributed_trace_async
async def get_required(self, *, parameter: str, **kwargs: Any) -> JSON:
"""Get true Boolean value on path.
Initially only has one required Query Parameter. After evolution, a new optional query
parameter is added.
"""Get true Boolean value on path. Initially only has one required Query Parameter. After
evolution, a new optional query parameter is added.

:keyword parameter: I am a required parameter. Required.
:paramtype parameter: str
Expand Down Expand Up @@ -327,9 +326,8 @@ async def post_parameters(self, parameter: Union[JSON, IO[bytes]], **kwargs: Any

@distributed_trace_async
async def get_optional(self, *, optional_param: Optional[str] = None, **kwargs: Any) -> JSON:
"""Get true Boolean value on path.
Initially has one optional query parameter. After evolution, a new optional query parameter is
added.
"""Get true Boolean value on path. Initially has one optional query parameter. After evolution, a
new optional query parameter is added.

:keyword optional_param: I am an optional parameter. Default value is None.
:paramtype optional_param: str
Expand Down
14 changes: 6 additions & 8 deletions ...enInitialVersionTolerant/dpgservicedriveninitialversiontolerant/operations/_operations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,8 @@ def __init__(self, *args, **kwargs) -> None:

@distributed_trace
def head_no_params(self, **kwargs: Any) -> JSON:
"""Head request, no params.
Initially has no query parameters. After evolution, a new optional query parameter is added.
"""Head request, no params. Initially has no query parameters. After evolution, a new optional
query parameter is added.

:return: JSON
:rtype: JSON
Expand Down Expand Up @@ -192,9 +192,8 @@ def head_no_params(self, **kwargs: Any) -> JSON:

@distributed_trace
def get_required(self, *, parameter: str, **kwargs: Any) -> JSON:
"""Get true Boolean value on path.
Initially only has one required Query Parameter. After evolution, a new optional query
parameter is added.
"""Get true Boolean value on path. Initially only has one required Query Parameter. After
evolution, a new optional query parameter is added.

:keyword parameter: I am a required parameter. Required.
:paramtype parameter: str
Expand Down Expand Up @@ -411,9 +410,8 @@ def post_parameters(self, parameter: Union[JSON, IO[bytes]], **kwargs: Any) -> J

@distributed_trace
def get_optional(self, *, optional_param: Optional[str] = None, **kwargs: Any) -> JSON:
"""Get true Boolean value on path.
Initially has one optional query parameter. After evolution, a new optional query parameter is
added.
"""Get true Boolean value on path. Initially has one optional query parameter. After evolution, a
new optional query parameter is added.

:keyword optional_param: I am an optional parameter. Default value is None.
:paramtype optional_param: str
Expand Down
20 changes: 8 additions & 12 deletions ...OneVersionTolerant/dpgservicedrivenupdateoneversiontolerant/aio/operations/_operations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,8 @@ async def head_no_params(self, *, new_parameter: Optional[str] = None, **kwargs:

@distributed_trace_async
async def get_required(self, *, parameter: str, new_parameter: Optional[str] = None, **kwargs: Any) -> JSON:
"""Get true Boolean value on path.
Initially only has one required Query Parameter. After evolution, a new optional query
parameter is added.
"""Get true Boolean value on path. Initially only has one required Query Parameter. After
evolution, a new optional query parameter is added.

:keyword parameter: I am a required parameter. Required.
:paramtype parameter: str
Expand Down Expand Up @@ -346,9 +345,8 @@ async def post_parameters(self, parameter: Union[JSON, IO[bytes]], **kwargs: Any

@distributed_trace_async
async def delete_parameters(self, **kwargs: Any) -> None:
"""Delete something.
Initially the path exists but there is no delete method. After evolution this is a new method
in a known path.
"""Delete something. Initially the path exists but there is no delete method. After evolution this
is a new method in a known path.

:return: None
:rtype: None
Expand Down Expand Up @@ -391,9 +389,8 @@ async def delete_parameters(self, **kwargs: Any) -> None:
async def get_optional(
self, *, optional_param: Optional[str] = None, new_parameter: Optional[str] = None, **kwargs: Any
) -> JSON:
"""Get true Boolean value on path.
Initially has one optional query parameter. After evolution, a new optional query parameter is
added.
"""Get true Boolean value on path. Initially has one optional query parameter. After evolution, a
new optional query parameter is added.

:keyword optional_param: I am an optional parameter. Default value is None.
:paramtype optional_param: str
Expand Down Expand Up @@ -447,9 +444,8 @@ async def get_optional(

@distributed_trace_async
async def get_new_operation(self, **kwargs: Any) -> JSON:
"""I'm a new operation.
Initiallty neither path or method exist for this operation. After evolution, this is a new
method in a new path.
"""I'm a new operation. Initiallty neither path or method exist for this operation. After
evolution, this is a new method in a new path.

:return: JSON
:rtype: JSON
Expand Down
20 changes: 8 additions & 12 deletions ...dateOneVersionTolerant/dpgservicedrivenupdateoneversiontolerant/operations/_operations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,9 +231,8 @@ def head_no_params(self, *, new_parameter: Optional[str] = None, **kwargs: Any)

@distributed_trace
def get_required(self, *, parameter: str, new_parameter: Optional[str] = None, **kwargs: Any) -> JSON:
"""Get true Boolean value on path.
Initially only has one required Query Parameter. After evolution, a new optional query
parameter is added.
"""Get true Boolean value on path. Initially only has one required Query Parameter. After
evolution, a new optional query parameter is added.

:keyword parameter: I am a required parameter. Required.
:paramtype parameter: str
Expand Down Expand Up @@ -466,9 +465,8 @@ def post_parameters(self, parameter: Union[JSON, IO[bytes]], **kwargs: Any) -> J

@distributed_trace
def delete_parameters(self, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements
"""Delete something.
Initially the path exists but there is no delete method. After evolution this is a new method
in a known path.
"""Delete something. Initially the path exists but there is no delete method. After evolution this
is a new method in a known path.

:return: None
:rtype: None
Expand Down Expand Up @@ -511,9 +509,8 @@ def delete_parameters(self, **kwargs: Any) -> None: # pylint: disable=inconsist
def get_optional(
self, *, optional_param: Optional[str] = None, new_parameter: Optional[str] = None, **kwargs: Any
) -> JSON:
"""Get true Boolean value on path.
Initially has one optional query parameter. After evolution, a new optional query parameter is
added.
"""Get true Boolean value on path. Initially has one optional query parameter. After evolution, a
new optional query parameter is added.

:keyword optional_param: I am an optional parameter. Default value is None.
:paramtype optional_param: str
Expand Down Expand Up @@ -567,9 +564,8 @@ def get_optional(

@distributed_trace
def get_new_operation(self, **kwargs: Any) -> JSON:
"""I'm a new operation.
Initiallty neither path or method exist for this operation. After evolution, this is a new
method in a new path.
"""I'm a new operation. Initiallty neither path or method exist for this operation. After
evolution, this is a new method in a new path.

:return: JSON
:rtype: JSON
Expand Down
6 changes: 2 additions & 4 deletions ...nerator-core-access/specs/azure/clientgenerator/core/access/aio/operations/_operations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -545,8 +545,7 @@ def __init__(self, *args, **kwargs) -> None:

@distributed_trace_async
async def _operation(self, *, name: str, **kwargs: Any) -> _models._models.OuterModel:
"""Expected query parameter: name="Madge"
Expected response body:
"""Expected query parameter: name="Madge" Expected response body:
Copy link
Contributor Author

@iscai-msft iscai-msft Jan 27, 2026

Choose a reason for hiding this comment

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

Since there is no . in the specs doc, we don't generate it on a new line. We're not sure of user intent so we don't indent, which helps us out in a lot of other ways


.. code-block:: json

Expand Down Expand Up @@ -615,8 +614,7 @@ async def _operation(self, *, name: str, **kwargs: Any) -> _models._models.Outer

@distributed_trace_async
async def _discriminator(self, *, kind: str, **kwargs: Any) -> _models._models.AbstractModel:
"""Expected query parameter: kind="real"
Expected response body:
"""Expected query parameter: kind="real" Expected response body:

.. code-block:: json

Expand Down
6 changes: 2 additions & 4 deletions ...t-generator-core-access/specs/azure/clientgenerator/core/access/operations/_operations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -714,8 +714,7 @@ def __init__(self, *args, **kwargs) -> None:

@distributed_trace
def _operation(self, *, name: str, **kwargs: Any) -> _models._models.OuterModel:
"""Expected query parameter: name="Madge"
Expected response body:
"""Expected query parameter: name="Madge" Expected response body:

.. code-block:: json

Expand Down Expand Up @@ -784,8 +783,7 @@ def _operation(self, *, name: str, **kwargs: Any) -> _models._models.OuterModel:

@distributed_trace
def _discriminator(self, *, kind: str, **kwargs: Any) -> _models._models.AbstractModel:
"""Expected query parameter: kind="real"
Expected response body:
"""Expected query parameter: kind="real" Expected response body:

.. code-block:: json

Expand Down
5 changes: 2 additions & 3 deletions ...ec-python/test/azure/generated/azure-core-traits/specs/azure/core/traits/models/_enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,5 @@ class RepeatabilityResult(str, Enum, metaclass=CaseInsensitiveEnumMeta):
execution of the operation."""
REJECTED = "rejected"
"""If the request was rejected because the combination of Repeatability-First-Sent and
Repeatability-Request-ID were invalid
or because the Repeatability-First-Sent value was outside the range of values held by the
server."""
Repeatability-Request-ID were invalid or because the Repeatability-First-Sent value was outside
the range of values held by the server."""
17 changes: 7 additions & 10 deletions ...est/azure/generated/specs-documentation/specs/documentation/aio/operations/_operations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,9 +300,8 @@ def __init__(self, *args, **kwargs) -> None:

@distributed_trace_async
async def bold_text(self, **kwargs: Any) -> None:
"""This is **bold text** in the middle of a sentence.
This is a sentence with **multiple bold** sections and **another bold** section.
**This entire sentence is bold.**.
"""This is **bold text** in the middle of a sentence. This is a sentence with **multiple bold**
sections and **another bold** section. **This entire sentence is bold.**.

:return: None
:rtype: None
Expand Down Expand Up @@ -346,9 +345,8 @@ async def bold_text(self, **kwargs: Any) -> None:

@distributed_trace_async
async def italic_text(self, **kwargs: Any) -> None:
"""This is *italic text* in the middle of a sentence.
This is a sentence with *multiple italic* sections and *another italic* section.
*This entire sentence is italic.*.
"""This is *italic text* in the middle of a sentence. This is a sentence with *multiple italic*
sections and *another italic* section. *This entire sentence is italic.*.

:return: None
:rtype: None
Expand Down Expand Up @@ -392,10 +390,9 @@ async def italic_text(self, **kwargs: Any) -> None:

@distributed_trace_async
async def combined_formatting(self, **kwargs: Any) -> None:
"""This sentence has **bold**, *italic*, and ***bold italic*** text.
You can also combine them like **bold with *italic inside* bold**.
Or *italic with **bold inside** italic*.
This is a sentence with **bold**, *italic*, and ***bold italic*** text.
"""This sentence has **bold**, *italic*, and ***bold italic*** text. You can also combine them
like **bold with *italic inside* bold**. Or *italic with **bold inside** italic*. This is a
sentence with **bold**, *italic*, and ***bold italic*** text.

:return: None
:rtype: None
Expand Down
17 changes: 7 additions & 10 deletions ...on/test/azure/generated/specs-documentation/specs/documentation/operations/_operations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,9 +342,8 @@ def __init__(self, *args, **kwargs) -> None:

@distributed_trace
def bold_text(self, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements
"""This is **bold text** in the middle of a sentence.
This is a sentence with **multiple bold** sections and **another bold** section.
**This entire sentence is bold.**.
"""This is **bold text** in the middle of a sentence. This is a sentence with **multiple bold**
sections and **another bold** section. **This entire sentence is bold.**.

:return: None
:rtype: None
Expand Down Expand Up @@ -388,9 +387,8 @@ def bold_text(self, **kwargs: Any) -> None: # pylint: disable=inconsistent-retu

@distributed_trace
def italic_text(self, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements
"""This is *italic text* in the middle of a sentence.
This is a sentence with *multiple italic* sections and *another italic* section.
*This entire sentence is italic.*.
"""This is *italic text* in the middle of a sentence. This is a sentence with *multiple italic*
sections and *another italic* section. *This entire sentence is italic.*.

:return: None
:rtype: None
Expand Down Expand Up @@ -434,10 +432,9 @@ def italic_text(self, **kwargs: Any) -> None: # pylint: disable=inconsistent-re

@distributed_trace
def combined_formatting(self, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements
"""This sentence has **bold**, *italic*, and ***bold italic*** text.
You can also combine them like **bold with *italic inside* bold**.
Or *italic with **bold inside** italic*.
This is a sentence with **bold**, *italic*, and ***bold italic*** text.
"""This sentence has **bold**, *italic*, and ***bold italic*** text. You can also combine them
like **bold with *italic inside* bold**. Or *italic with **bold inside** italic*. This is a
sentence with **bold**, *italic*, and ***bold italic*** text.

:return: None
:rtype: None
Expand Down
17 changes: 7 additions & 10 deletions ...unbranded/generated/specs-documentation/specs/documentation/aio/operations/_operations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,9 +283,8 @@ def __init__(self, *args, **kwargs) -> None:
self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer")

async def bold_text(self, **kwargs: Any) -> None:
"""This is **bold text** in the middle of a sentence.
This is a sentence with **multiple bold** sections and **another bold** section.
**This entire sentence is bold.**.
"""This is **bold text** in the middle of a sentence. This is a sentence with **multiple bold**
sections and **another bold** section. **This entire sentence is bold.**.

:return: None
:rtype: None
Expand Down Expand Up @@ -326,9 +325,8 @@ async def bold_text(self, **kwargs: Any) -> None:
return cls(pipeline_response, None, {}) # type: ignore

async def italic_text(self, **kwargs: Any) -> None:
"""This is *italic text* in the middle of a sentence.
This is a sentence with *multiple italic* sections and *another italic* section.
*This entire sentence is italic.*.
"""This is *italic text* in the middle of a sentence. This is a sentence with *multiple italic*
sections and *another italic* section. *This entire sentence is italic.*.

:return: None
:rtype: None
Expand Down Expand Up @@ -369,10 +367,9 @@ async def italic_text(self, **kwargs: Any) -> None:
return cls(pipeline_response, None, {}) # type: ignore

async def combined_formatting(self, **kwargs: Any) -> None:
"""This sentence has **bold**, *italic*, and ***bold italic*** text.
You can also combine them like **bold with *italic inside* bold**.
Or *italic with **bold inside** italic*.
This is a sentence with **bold**, *italic*, and ***bold italic*** text.
"""This sentence has **bold**, *italic*, and ***bold italic*** text. You can also combine them
like **bold with *italic inside* bold**. Or *italic with **bold inside** italic*. This is a
sentence with **bold**, *italic*, and ***bold italic*** text.

:return: None
:rtype: None
Expand Down
17 changes: 7 additions & 10 deletions ...est/unbranded/generated/specs-documentation/specs/documentation/operations/_operations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,9 +325,8 @@ def __init__(self, *args, **kwargs) -> None:
self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer")

def bold_text(self, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements
"""This is **bold text** in the middle of a sentence.
This is a sentence with **multiple bold** sections and **another bold** section.
**This entire sentence is bold.**.
"""This is **bold text** in the middle of a sentence. This is a sentence with **multiple bold**
sections and **another bold** section. **This entire sentence is bold.**.

:return: None
:rtype: None
Expand Down Expand Up @@ -368,9 +367,8 @@ def bold_text(self, **kwargs: Any) -> None: # pylint: disable=inconsistent-retu
return cls(pipeline_response, None, {}) # type: ignore

def italic_text(self, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements
"""This is *italic text* in the middle of a sentence.
This is a sentence with *multiple italic* sections and *another italic* section.
*This entire sentence is italic.*.
"""This is *italic text* in the middle of a sentence. This is a sentence with *multiple italic*
sections and *another italic* section. *This entire sentence is italic.*.

:return: None
:rtype: None
Expand Down Expand Up @@ -411,10 +409,9 @@ def italic_text(self, **kwargs: Any) -> None: # pylint: disable=inconsistent-re
return cls(pipeline_response, None, {}) # type: ignore

def combined_formatting(self, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements
"""This sentence has **bold**, *italic*, and ***bold italic*** text.
You can also combine them like **bold with *italic inside* bold**.
Or *italic with **bold inside** italic*.
This is a sentence with **bold**, *italic*, and ***bold italic*** text.
"""This sentence has **bold**, *italic*, and ***bold italic*** text. You can also combine them
like **bold with *italic inside* bold**. Or *italic with **bold inside** italic*. This is a
sentence with **bold**, *italic*, and ***bold italic*** text.

:return: None
:rtype: None
Expand Down
Loading
Loading