@@ -71,11 +71,13 @@ Use license_matrix.json (part of the project) by default. Json format is:
71
71
72
72
#### Arguments
73
73
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".
75
76
76
77
#### Returns
77
78
78
- - ` list[License] ` - list of Licenses
79
+ -------
80
+ - ` list[License] ` - list of Licenses
79
81
80
82
#### Signature
81
83
@@ -87,17 +89,19 @@ def buildLicenses(
87
89
88
90
### LicenseMatrix().closestSPDX
89
91
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 )
91
93
92
94
Guarantee a license from a spdx id (may be inaccurate).
93
95
94
96
#### Arguments
95
97
96
- - ` spdx ` * str* - spdx id to lookup
98
+ ----
99
+ - ` spdx ` * str* - spdx id to lookup
97
100
98
101
#### Returns
99
102
100
- - ` License ` - license
103
+ -------
104
+ - ` License ` - license
101
105
102
106
#### Signature
103
107
@@ -107,17 +111,19 @@ def closestSPDX(self, spdx: str) -> License: ...
107
111
108
112
### LicenseMatrix().closestTitle
109
113
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 )
111
115
112
116
Guarantee a license from a name (may be inaccurate).
113
117
114
118
#### Arguments
115
119
116
- - ` name ` * str* - name to lookup
120
+ ----
121
+ - ` name ` * str* - name to lookup
117
122
118
123
#### Returns
119
124
120
- - ` License ` - license
125
+ -------
126
+ - ` License ` - license
121
127
122
128
#### Signature
123
129
@@ -127,17 +133,19 @@ def closestTitle(self, name: str) -> License: ...
127
133
128
134
### LicenseMatrix().licenseFromAltName
129
135
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 )
131
137
132
138
Get the license from an altName.
133
139
134
140
#### Arguments
135
141
136
- - ` altName ` * str* - altName to lookup
142
+ ----
143
+ - ` altName ` * str* - altName to lookup
137
144
138
145
#### Returns
139
146
140
- - ` Optional[License] ` - license
147
+ -------
148
+ - ` Optional[License] ` - license
141
149
142
150
#### Signature
143
151
@@ -147,17 +155,19 @@ def licenseFromAltName(self, altName: str) -> License | None: ...
147
155
148
156
### LicenseMatrix().licenseFromName
149
157
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 )
151
159
152
160
Get the license from a name.
153
161
154
162
#### Arguments
155
163
156
- - ` name ` * str* - name to lookup
164
+ ----
165
+ - ` name ` * str* - name to lookup
157
166
158
167
#### Returns
159
168
160
- - ` Optional[License] ` - license
169
+ -------
170
+ - ` Optional[License] ` - license
161
171
162
172
#### Signature
163
173
@@ -167,17 +177,19 @@ def licenseFromName(self, name: str) -> License | None: ...
167
177
168
178
### LicenseMatrix().licenseFromSPDX
169
179
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 )
171
181
172
182
Get the license from a spdx id.
173
183
174
184
#### Arguments
175
185
176
- - ` spdx ` * str* - spdx id to lookup
186
+ ----
187
+ - ` spdx ` * str* - spdx id to lookup
177
188
178
189
#### Returns
179
190
180
- - ` Optional[License] ` - license
191
+ -------
192
+ - ` Optional[License] ` - license
181
193
182
194
#### Signature
183
195
@@ -187,17 +199,19 @@ def licenseFromSPDX(self, spdx: str) -> License | None: ...
187
199
188
200
### LicenseMatrix().searchLicenses
189
201
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 )
191
203
192
204
Get a list of candidate licenses from a search string.
193
205
194
206
#### Arguments
195
207
196
- - ` search ` * str* - search string
208
+ ----
209
+ - ` search ` * str* - search string
197
210
198
211
#### Returns
199
212
200
- - ` list[License] ` - list of licenses
213
+ -------
214
+ - ` list[License] ` - list of licenses
201
215
202
216
#### Signature
203
217
0 commit comments