Skip to content

Commit d7c789e

Browse files
committed
ruff
1 parent ede2998 commit d7c789e

File tree

9 files changed

+198
-131
lines changed

9 files changed

+198
-131
lines changed

.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
repos:
22
- repo: https://github.com/astral-sh/ruff-pre-commit
3-
rev: v0.2.2
3+
rev: v0.3.3
44
hooks:
55
- id: ruff
66
args: [ --fix ]
77
- id: ruff-format
88

99
- repo: https://github.com/RobertCraigie/pyright-python
10-
rev: v1.1.351
10+
rev: v1.1.354
1111
hooks:
1212
- id: pyright
1313

documentation/reference/licensematrix/license_matrix.md

Lines changed: 34 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,13 @@ Use license_matrix.json (part of the project) by default. Json format is:
7171

7272
#### Arguments
7373

74-
- `fileName` *str, optional* - the file path to process. Defaults to THISDIR+"/license_matrix.json".
74+
----
75+
- `fileName` *str, optional* - the file path to process. Defaults to THISDIR+"/license_matrix.json".
7576

7677
#### Returns
7778

78-
- `list[License]` - list of Licenses
79+
-------
80+
- `list[License]` - list of Licenses
7981

8082
#### Signature
8183

@@ -87,17 +89,19 @@ def buildLicenses(
8789

8890
### LicenseMatrix().closestSPDX
8991

90-
[Show source in license_matrix.py:140](../../../licensematrix/license_matrix.py#L140)
92+
[Show source in license_matrix.py:150](../../../licensematrix/license_matrix.py#L150)
9193

9294
Guarantee a license from a spdx id (may be inaccurate).
9395

9496
#### Arguments
9597

96-
- `spdx` *str* - spdx id to lookup
98+
----
99+
- `spdx` *str* - spdx id to lookup
97100

98101
#### Returns
99102

100-
- `License` - license
103+
-------
104+
- `License` - license
101105

102106
#### Signature
103107

@@ -107,17 +111,19 @@ def closestSPDX(self, spdx: str) -> License: ...
107111

108112
### LicenseMatrix().closestTitle
109113

110-
[Show source in license_matrix.py:156](../../../licensematrix/license_matrix.py#L156)
114+
[Show source in license_matrix.py:167](../../../licensematrix/license_matrix.py#L167)
111115

112116
Guarantee a license from a name (may be inaccurate).
113117

114118
#### Arguments
115119

116-
- `name` *str* - name to lookup
120+
----
121+
- `name` *str* - name to lookup
117122

118123
#### Returns
119124

120-
- `License` - license
125+
-------
126+
- `License` - license
121127

122128
#### Signature
123129

@@ -127,17 +133,19 @@ def closestTitle(self, name: str) -> License: ...
127133

128134
### LicenseMatrix().licenseFromAltName
129135

130-
[Show source in license_matrix.py:105](../../../licensematrix/license_matrix.py#L105)
136+
[Show source in license_matrix.py:109](../../../licensematrix/license_matrix.py#L109)
131137

132138
Get the license from an altName.
133139

134140
#### Arguments
135141

136-
- `altName` *str* - altName to lookup
142+
----
143+
- `altName` *str* - altName to lookup
137144

138145
#### Returns
139146

140-
- `Optional[License]` - license
147+
-------
148+
- `Optional[License]` - license
141149

142150
#### Signature
143151

@@ -147,17 +155,19 @@ def licenseFromAltName(self, altName: str) -> License | None: ...
147155

148156
### LicenseMatrix().licenseFromName
149157

150-
[Show source in license_matrix.py:91](../../../licensematrix/license_matrix.py#L91)
158+
[Show source in license_matrix.py:92](../../../licensematrix/license_matrix.py#L92)
151159

152160
Get the license from a name.
153161

154162
#### Arguments
155163

156-
- `name` *str* - name to lookup
164+
----
165+
- `name` *str* - name to lookup
157166

158167
#### Returns
159168

160-
- `Optional[License]` - license
169+
-------
170+
- `Optional[License]` - license
161171

162172
#### Signature
163173

@@ -167,17 +177,19 @@ def licenseFromName(self, name: str) -> License | None: ...
167177

168178
### LicenseMatrix().licenseFromSPDX
169179

170-
[Show source in license_matrix.py:77](../../../licensematrix/license_matrix.py#L77)
180+
[Show source in license_matrix.py:75](../../../licensematrix/license_matrix.py#L75)
171181

172182
Get the license from a spdx id.
173183

174184
#### Arguments
175185

176-
- `spdx` *str* - spdx id to lookup
186+
----
187+
- `spdx` *str* - spdx id to lookup
177188

178189
#### Returns
179190

180-
- `Optional[License]` - license
191+
-------
192+
- `Optional[License]` - license
181193

182194
#### Signature
183195

@@ -187,17 +199,19 @@ def licenseFromSPDX(self, spdx: str) -> License | None: ...
187199

188200
### LicenseMatrix().searchLicenses
189201

190-
[Show source in license_matrix.py:120](../../../licensematrix/license_matrix.py#L120)
202+
[Show source in license_matrix.py:127](../../../licensematrix/license_matrix.py#L127)
191203

192204
Get a list of candidate licenses from a search string.
193205

194206
#### Arguments
195207

196-
- `search` *str* - search string
208+
----
209+
- `search` *str* - search string
197210

198211
#### Returns
199212

200-
- `list[License]` - list of licenses
213+
-------
214+
- `list[License]` - list of licenses
201215

202216
#### Signature
203217

0 commit comments

Comments
 (0)