-
Notifications
You must be signed in to change notification settings - Fork 647
/
examples.py
59 lines (46 loc) · 1.62 KB
/
examples.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# noqa: MD01
# Licensed to Modin Development Team under one or more contributor license agreements.
# See the NOTICE file distributed with this work for additional information regarding
# copyright ownership. The Modin Development Team licenses this file to you under the
# Apache License, Version 2.0 (the "License"); you may not use this file except in
# compliance with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software distributed under
# the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific language
# governing permissions and limitations under the License.
# noqa: MD02
"""Function examples for docstring testing."""
class weakdict(dict): # noqa: GL08
__slots__ = ("__weakref__",)
def optional_square(number: int = 5) -> int: # noqa
"""
Square `number`.
The function from Modin.
Parameters
----------
number : int
Some number.
Notes
-----
The `optional_square` Modin function from modin/scripts/examples.py.
"""
return number ** 2
def optional_square_empty_parameters(number: int = 5) -> int:
"""
Parameters
----------
"""
return number ** 2
def square_summary(number: int) -> int: # noqa: PR01, GL08
"""
Square `number`.
See https://github.com/ray-project/ray.
Examples
--------
The function that will never be used in modin.pandas.DataFrame same as in
Pandas or Numpy.
"""
return number ** 2