Skip to content

Commit d7b20cb

Browse files
Remove colon (':') from keywords such as "Parameters" and "Remarks" in comments (#2130)
Co-authored-by: tracyboehrer <tracyboehrer@users.noreply.github.com>
1 parent c20b27b commit d7b20cb

19 files changed

+24
-24
lines changed

libraries/botbuilder-ai/botbuilder/ai/qna/models/join_operator.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ class JoinOperator(str, Enum):
88
"""
99
Join Operator for Strict Filters.
1010
11-
remarks:
11+
remarks
1212
--------
1313
For example, when using multiple filters in a query, if you want results that
1414
have metadata that matches all filters, then use `AND` operator.

libraries/botbuilder-ai/botbuilder/ai/qna/models/qna_response_context.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class QnAResponseContext(Model):
1717

1818
def __init__(self, **kwargs):
1919
"""
20-
Parameters:
20+
Parameters
2121
-----------
2222
2323
is_context_only: Whether this prompt is context only.

libraries/botbuilder-ai/botbuilder/ai/qna/models/qnamaker_trace_info.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ def __init__(
2727
ranker_type: str = RankerTypes.DEFAULT,
2828
):
2929
"""
30-
Parameters:
30+
Parameters
3131
-----------
3232
3333
message: Message which instigated the query to QnA Maker.

libraries/botbuilder-ai/botbuilder/ai/qna/models/query_results.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ def __init__(
1818
self, answers: List[QueryResult], active_learning_enabled: bool = None, **kwargs
1919
):
2020
"""
21-
Parameters:
21+
Parameters
2222
-----------
2323
2424
answers: The answers for a user query.

libraries/botbuilder-ai/botbuilder/ai/qna/qnamaker_options.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ class QnAMakerOptions:
1010
"""
1111
Defines options used to configure a `QnAMaker` instance.
1212
13-
remarks:
13+
remarks
1414
--------
1515
All parameters are optional.
1616
"""
@@ -28,7 +28,7 @@ def __init__(
2828
strict_filters_join_operator: str = JoinOperator.AND,
2929
):
3030
"""
31-
Parameters:
31+
Parameters
3232
-----------
3333
score_threshold (float):
3434
The minimum score threshold, used to filter returned results.

libraries/botbuilder-ai/botbuilder/ai/qna/utils/active_learning_utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ def get_low_score_variation(
2222
"""
2323
Returns a list of QnA search results, which have low score variation.
2424
25-
Parameters:
25+
Parameters
2626
-----------
2727
2828
qna_serach_results: A list of QnA QueryResults returned from the QnA GenerateAnswer API call.

libraries/botbuilder-ai/botbuilder/ai/qna/utils/generate_answer_utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def __init__(
4141
http_client: ClientSession,
4242
):
4343
"""
44-
Parameters:
44+
Parameters
4545
-----------
4646
4747
telemetry_client: Telemetry client.

libraries/botbuilder-ai/botbuilder/ai/qna/utils/http_request_utils.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
class HttpRequestUtils:
1717
"""HTTP request utils class.
1818
19-
Parameters:
19+
Parameters
2020
-----------
2121
2222
http_client: Client to make HTTP requests with. Default client used in the SDK is `aiohttp.ClientSession`.
@@ -35,7 +35,7 @@ async def execute_http_request(
3535
"""
3636
Execute HTTP request.
3737
38-
Parameters:
38+
Parameters
3939
-----------
4040
4141
request_url: HTTP request URL.

libraries/botbuilder-ai/botbuilder/ai/qna/utils/train_utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ def __init__(self, endpoint: QnAMakerEndpoint, http_client: ClientSession):
1717
"""
1818
Initializes a new instance for active learning train utils.
1919
20-
Parameters:
20+
Parameters
2121
-----------
2222
2323
endpoint: QnA Maker Endpoint of the knowledge base to query.

libraries/botbuilder-dialogs/botbuilder/dialogs/choices/choice_factory.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ def for_channel(
2626
Creates a message activity that includes a list of choices formatted based on the
2727
capabilities of a given channel.
2828
29-
Parameters:
29+
Parameters
3030
----------
3131
channel_id: A channel ID.
3232
choices: List of choices to render
@@ -81,7 +81,7 @@ def inline(
8181
"""
8282
Creates a message activity that includes a list of choices formatted as an inline list.
8383
84-
Parameters:
84+
Parameters
8585
----------
8686
choices: The list of choices to render.
8787
text: (Optional) The text of the message to send.
@@ -140,7 +140,7 @@ def list_style(
140140
"""
141141
Creates a message activity that includes a list of choices formatted as a numbered or bulleted list.
142142
143-
Parameters:
143+
Parameters
144144
----------
145145
146146
choices: The list of choices to render.

libraries/botbuilder-dialogs/botbuilder/dialogs/choices/choice_recognizers.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ def recognize_choices(
3434
- By 1's based ordinal position.
3535
- By 1's based index position.
3636
37-
Parameters:
37+
Parameters
3838
-----------
3939
4040
utterance: The input.
@@ -43,7 +43,7 @@ def recognize_choices(
4343
4444
options: (Optional) Options to control the recognition strategy.
4545
46-
Returns:
46+
Returns
4747
--------
4848
A list of found choices, sorted by most relevant first.
4949
"""

libraries/botbuilder-dialogs/botbuilder/dialogs/choices/find_choices_options.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ def __init__(
1616
**kwargs,
1717
):
1818
"""
19-
Parameters:
19+
Parameters
2020
-----------
2121
2222
no_value: (Optional) If `True`, the choices `value` field will NOT be search over. Defaults to `False`.

libraries/botbuilder-dialogs/botbuilder/dialogs/choices/find_values_options.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ def __init__(
1717
tokenizer: Callable[[str, str], List[Token]] = None,
1818
):
1919
"""
20-
Parameters:
20+
Parameters
2121
----------
2222
2323
allow_partial_matches: (Optional) If `True`, then only some of the tokens in a value need to exist to

libraries/botbuilder-dialogs/botbuilder/dialogs/choices/found_choice.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ class FoundChoice:
77

88
def __init__(self, value: str, index: int, score: float, synonym: str = None):
99
"""
10-
Parameters:
10+
Parameters
1111
----------
1212
1313
value: The value of the choice that was matched.

libraries/botbuilder-dialogs/botbuilder/dialogs/choices/found_value.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ class FoundValue:
77

88
def __init__(self, value: str, index: int, score: float):
99
"""
10-
Parameters:
10+
Parameters
1111
----------
1212
1313
value: The value that was matched.

libraries/botbuilder-dialogs/botbuilder/dialogs/choices/model_result.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ def __init__(
99
self, text: str, start: int, end: int, type_name: str, resolution: object
1010
):
1111
"""
12-
Parameters:
12+
Parameters
1313
----------
1414
1515
text: Substring of the utterance that was recognized.

libraries/botbuilder-dialogs/botbuilder/dialogs/choices/sorted_value.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ class SortedValue:
77

88
def __init__(self, value: str, index: int):
99
"""
10-
Parameters:
10+
Parameters
1111
-----------
1212
1313
value: The value that will be sorted.

libraries/botbuilder-dialogs/botbuilder/dialogs/choices/token.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ class Token:
77

88
def __init__(self, start: int, end: int, text: str, normalized: str):
99
"""
10-
Parameters:
10+
Parameters
1111
----------
1212
1313
start: The index of the first character of the token within the outer input string.

libraries/botbuilder-dialogs/botbuilder/dialogs/choices/tokenizer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ def _is_breaking_char(code_point) -> bool:
7575
@staticmethod
7676
def _is_between(value: int, from_val: int, to_val: int) -> bool:
7777
"""
78-
Parameters:
78+
Parameters
7979
-----------
8080
8181
value: number value

0 commit comments

Comments
 (0)