Skip to content
Snippets Groups Projects
Commit f03f2740 authored by vlorentz's avatar vlorentz
Browse files

Fix argument syntax to remove warnings and use Napoleon

parent cc04dd0b
No related branches found
No related tags found
No related merge requests found
...@@ -347,11 +347,12 @@ def identify_revision( ...@@ -347,11 +347,12 @@ def identify_revision(
) -> Iterator[RevisionIdentity]: ) -> Iterator[RevisionIdentity]:
"""Return the repository revision identities. """Return the repository revision identities.
hg: A `Hg` repository instance Args:
rev: An optional revision or Mercurial revsets (See `hg help revsets`) hg: A `Hg` repository instance
If not provided all the repository revisions will be computed. rev: An optional revision or Mercurial revsets (See `hg help revsets`)
node_id_2_swhid: An optional cache mapping hg node ids to SWHIDs If not provided all the repository revisions will be computed.
It will be updated in place with new mappings. node_id_2_swhid: An optional cache mapping hg node ids to SWHIDs
It will be updated in place with new mappings.
""" """
from swh.model.model import Revision from swh.model.model import Revision
...@@ -406,9 +407,10 @@ def identify_release( ...@@ -406,9 +407,10 @@ def identify_release(
) -> Iterator[ReleaseIdentity]: ) -> Iterator[ReleaseIdentity]:
"""Return the repository's release identities. """Return the repository's release identities.
hg: A `Hg` repository instance Args:
node_id_2_swhid: An optional cache mapping hg node ids to SWHIDs hg: A `Hg` repository instance
If not provided it will be computed using `identify_revision`. node_id_2_swhid: An optional cache mapping hg node ids to SWHIDs
If not provided it will be computed using `identify_revision`.
""" """
from swh.model.model import ObjectType as ModelObjectType from swh.model.model import ObjectType as ModelObjectType
from swh.model.model import Release from swh.model.model import Release
...@@ -445,11 +447,12 @@ def identify_snapshot( ...@@ -445,11 +447,12 @@ def identify_snapshot(
) -> CoreSWHID: ) -> CoreSWHID:
"""Return the repository snapshot identity. """Return the repository snapshot identity.
hg: A `Hg` repository instance Args:
node_id_2_swhid: An optional cache mapping hg node ids to SWHIDs hg: A `Hg` repository instance
If not provided it will be computed using `identify_revision`. node_id_2_swhid: An optional cache mapping hg node ids to SWHIDs
release: an optional list of `ReleaseIdentity`. If not provided it will be computed using `identify_revision`.
If not provided it will be computed using `identify_release`. release: an optional list of `ReleaseIdentity`.
If not provided it will be computed using `identify_release`.
""" """
from swh.model.model import Snapshot, TargetType from swh.model.model import Snapshot, TargetType
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment