Skip to content
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

Jump to bottom

Remove the colon (':') from keywords such as "Parameters", "Remarks" and "Returns" in comments. #2130

Merged
merged 2 commits into from
Jul 1, 2024
Merged

Remove the colon (':') from keywords such as "Parameters", "Remarks" and "Returns" in comments. #2130

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
6c488f6
Remove colon (':') from keywords such as "Parameters" and "Remarks" i…
gandiddi Jun 28, 2024
95ce3b6
Merge branch 'main' into v-gandiddi/RemoveColon
tracyboehrer Jul 1, 2024
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 libraries/botbuilder-ai/botbuilder/ai/qna/models/join_operator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ class JoinOperator(str, Enum):
"""
Join Operator for Strict Filters.

remarks:
remarks
--------
For example, when using multiple filters in a query, if you want results that
have metadata that matches all filters, then use `AND` operator.
Expand Down
2 changes: 1 addition & 1 deletion libraries/botbuilder-ai/botbuilder/ai/qna/models/qna_response_context.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class QnAResponseContext(Model):

def __init__(self, **kwargs):
"""
Parameters:
Parameters
-----------

is_context_only: Whether this prompt is context only.
Expand Down
2 changes: 1 addition & 1 deletion libraries/botbuilder-ai/botbuilder/ai/qna/models/qnamaker_trace_info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ def __init__(
ranker_type: str = RankerTypes.DEFAULT,
):
"""
Parameters:
Parameters
-----------

message: Message which instigated the query to QnA Maker.
Expand Down
2 changes: 1 addition & 1 deletion libraries/botbuilder-ai/botbuilder/ai/qna/models/query_results.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ def __init__(
self, answers: List[QueryResult], active_learning_enabled: bool = None, **kwargs
):
"""
Parameters:
Parameters
-----------

answers: The answers for a user query.
Expand Down
4 changes: 2 additions & 2 deletions libraries/botbuilder-ai/botbuilder/ai/qna/qnamaker_options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ class QnAMakerOptions:
"""
Defines options used to configure a `QnAMaker` instance.

remarks:
remarks
--------
All parameters are optional.
"""
Expand All @@ -28,7 +28,7 @@ def __init__(
strict_filters_join_operator: str = JoinOperator.AND,
):
"""
Parameters:
Parameters
-----------
score_threshold (float):
The minimum score threshold, used to filter returned results.
Expand Down
2 changes: 1 addition & 1 deletion libraries/botbuilder-ai/botbuilder/ai/qna/utils/active_learning_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ def get_low_score_variation(
"""
Returns a list of QnA search results, which have low score variation.

Parameters:
Parameters
-----------

qna_serach_results: A list of QnA QueryResults returned from the QnA GenerateAnswer API call.
Expand Down
2 changes: 1 addition & 1 deletion libraries/botbuilder-ai/botbuilder/ai/qna/utils/generate_answer_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def __init__(
http_client: ClientSession,
):
"""
Parameters:
Parameters
-----------

telemetry_client: Telemetry client.
Expand Down
4 changes: 2 additions & 2 deletions libraries/botbuilder-ai/botbuilder/ai/qna/utils/http_request_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
class HttpRequestUtils:
"""HTTP request utils class.

Parameters:
Parameters
-----------

http_client: Client to make HTTP requests with. Default client used in the SDK is `aiohttp.ClientSession`.
Expand All @@ -35,7 +35,7 @@ async def execute_http_request(
"""
Execute HTTP request.

Parameters:
Parameters
-----------

request_url: HTTP request URL.
Expand Down
2 changes: 1 addition & 1 deletion libraries/botbuilder-ai/botbuilder/ai/qna/utils/train_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ def __init__(self, endpoint: QnAMakerEndpoint, http_client: ClientSession):
"""
Initializes a new instance for active learning train utils.

Parameters:
Parameters
-----------

endpoint: QnA Maker Endpoint of the knowledge base to query.
Expand Down
6 changes: 3 additions & 3 deletions libraries/botbuilder-dialogs/botbuilder/dialogs/choices/choice_factory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ def for_channel(
Creates a message activity that includes a list of choices formatted based on the
capabilities of a given channel.

Parameters:
Parameters
----------
channel_id: A channel ID.
choices: List of choices to render
Expand Down Expand Up @@ -81,7 +81,7 @@ def inline(
"""
Creates a message activity that includes a list of choices formatted as an inline list.

Parameters:
Parameters
----------
choices: The list of choices to render.
text: (Optional) The text of the message to send.
Expand Down Expand Up @@ -140,7 +140,7 @@ def list_style(
"""
Creates a message activity that includes a list of choices formatted as a numbered or bulleted list.

Parameters:
Parameters
----------

choices: The list of choices to render.
Expand Down
4 changes: 2 additions & 2 deletions libraries/botbuilder-dialogs/botbuilder/dialogs/choices/choice_recognizers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ def recognize_choices(
- By 1's based ordinal position.
- By 1's based index position.

Parameters:
Parameters
-----------

utterance: The input.
Expand All @@ -43,7 +43,7 @@ def recognize_choices(

options: (Optional) Options to control the recognition strategy.

Returns:
Returns
--------
A list of found choices, sorted by most relevant first.
"""
Expand Down
2 changes: 1 addition & 1 deletion libraries/botbuilder-dialogs/botbuilder/dialogs/choices/find_choices_options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ def __init__(
**kwargs,
):
"""
Parameters:
Parameters
-----------

no_value: (Optional) If `True`, the choices `value` field will NOT be search over. Defaults to `False`.
Expand Down
2 changes: 1 addition & 1 deletion libraries/botbuilder-dialogs/botbuilder/dialogs/choices/find_values_options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ def __init__(
tokenizer: Callable[[str, str], List[Token]] = None,
):
"""
Parameters:
Parameters
----------

allow_partial_matches: (Optional) If `True`, then only some of the tokens in a value need to exist to
Expand Down
2 changes: 1 addition & 1 deletion libraries/botbuilder-dialogs/botbuilder/dialogs/choices/found_choice.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ class FoundChoice:

def __init__(self, value: str, index: int, score: float, synonym: str = None):
"""
Parameters:
Parameters
----------

value: The value of the choice that was matched.
Expand Down
2 changes: 1 addition & 1 deletion libraries/botbuilder-dialogs/botbuilder/dialogs/choices/found_value.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ class FoundValue:

def __init__(self, value: str, index: int, score: float):
"""
Parameters:
Parameters
----------

value: The value that was matched.
Expand Down
2 changes: 1 addition & 1 deletion libraries/botbuilder-dialogs/botbuilder/dialogs/choices/model_result.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ def __init__(
self, text: str, start: int, end: int, type_name: str, resolution: object
):
"""
Parameters:
Parameters
----------

text: Substring of the utterance that was recognized.
Expand Down
2 changes: 1 addition & 1 deletion libraries/botbuilder-dialogs/botbuilder/dialogs/choices/sorted_value.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ class SortedValue:

def __init__(self, value: str, index: int):
"""
Parameters:
Parameters
-----------

value: The value that will be sorted.
Expand Down
2 changes: 1 addition & 1 deletion libraries/botbuilder-dialogs/botbuilder/dialogs/choices/token.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ class Token:

def __init__(self, start: int, end: int, text: str, normalized: str):
"""
Parameters:
Parameters
----------

start: The index of the first character of the token within the outer input string.
Expand Down
2 changes: 1 addition & 1 deletion libraries/botbuilder-dialogs/botbuilder/dialogs/choices/tokenizer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ def _is_breaking_char(code_point) -> bool:
@staticmethod
def _is_between(value: int, from_val: int, to_val: int) -> bool:
"""
Parameters:
Parameters
-----------

value: number value
Expand Down
Loading