Skip to content

Commit 3882ee4

Browse files
committed
Fix RST formatting for title underlines
Signed-off-by: lelia <2418071+lelia@users.noreply.github.com>
1 parent 7a57c40 commit 3882ee4

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

README.rst

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -28,35 +28,35 @@ Supported Functions
2828
-------------------
2929

3030

31-
purl.post(license, components, org_slug=None)
32-
"""""""""""""""""""""""""""""""""""""""""""
33-
Retrieve package information for one or more PURLs. Pass ``org_slug`` to use the
34-
current org-scoped endpoint. Omitting ``org_slug`` keeps the legacy deprecated
35-
endpoint for backwards compatibility.
31+
purl.post(license, components, org_slug=None)
32+
"""""""""""""""""""""""""""""""""""""""""""""
33+
Retrieve package information for one or more PURLs. Pass ``org_slug`` to use the
34+
current org-scoped endpoint. Omitting ``org_slug`` keeps the legacy deprecated
35+
endpoint for backwards compatibility.
3636

3737
**Usage:**
3838

3939
.. code-block:: python
4040
41-
from socketdev import socketdev
42-
socket = socketdev(token="REPLACE_ME")
43-
org_slug = "your-org-slug"
44-
license = "true"
45-
components = [
46-
{
41+
from socketdev import socketdev
42+
socket = socketdev(token="REPLACE_ME")
43+
org_slug = "your-org-slug"
44+
license = "true"
45+
components = [
46+
{
4747
"purl": "pkg:pypi/pyonepassword@5.0.0"
4848
},
4949
{
50-
"purl": "pkg:pypi/socketsecurity"
51-
}
52-
]
53-
print(socket.purl.post(license, components, org_slug=org_slug))
50+
"purl": "pkg:pypi/socketsecurity"
51+
}
52+
]
53+
print(socket.purl.post(license, components, org_slug=org_slug))
5454
5555
**PARAMETERS:**
5656

57-
- **license (str)** - The license parameter if enabled will show alerts and license information. If disabled will only show the basic package metadata and scores. Default is true
58-
- **components (array{dict})** - The components list of packages urls
59-
- **org_slug (str, optional)** - Organization slug for the supported org-scoped PURL endpoint. If omitted, the SDK uses the deprecated legacy endpoint for backwards compatibility.
57+
- **license (str)** - The license parameter if enabled will show alerts and license information. If disabled will only show the basic package metadata and scores. Default is true
58+
- **components (array{dict})** - The components list of packages urls
59+
- **org_slug (str, optional)** - Organization slug for the supported org-scoped PURL endpoint. If omitted, the SDK uses the deprecated legacy endpoint for backwards compatibility.
6060

6161
export.cdx_bom(org_slug, id, query_params)
6262
""""""""""""""""""""""""""""""""""""""""""

0 commit comments

Comments
 (0)