aries-cloudagent-python icon indicating copy to clipboard operation
aries-cloudagent-python copied to clipboard

Fix sphinx errors from docstring strings that are badly constructed

Open swcurran opened this issue 1 year ago • 0 comments

Sphinx building is generating the following errors due to badly formatted docstrings.

Files:

  • aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat
  • aries_cloudagent/protocols/issue_credential/v2_0/messages/cred_format.py
  • aries_cloudagent.protocols.present_proof.v2_0.messages.pres_format.V20PresFormat
  • aries_cloudagent/resolver/default/legacy_peer.py

Errors:


docstring of aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat.Format.INDY:5: ERROR: Unexpected indentation.
docstring of aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat.Format.INDY:8: ERROR: Unexpected indentation.
aries_cloudagent/protocols/issue_credential/v2_0/messages/cred_format.py:docstring of aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.FormatSpec:1: WARNING: Block quote ends without a blank line; unexpected unindent.
aries_cloudagent/protocols/issue_credential/v2_0/messages/cred_format.py:docstring of aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.FormatSpec:1: WARNING: Block quote ends without a blank line; unexpected unindent.
docstring of aries_cloudagent.protocols.present_proof.v2_0.messages.pres_format.V20PresFormat.Format.INDY:3: ERROR: Unexpected indentation.
docstring of aries_cloudagent.protocols.present_proof.v2_0.messages.pres_format.V20PresFormat.Format.INDY:5: ERROR: Unexpected indentation.
aries_cloudagent/protocols/present_proof/v2_0/messages/pres_format.py:docstring of aries_cloudagent.protocols.present_proof.v2_0.messages.pres_format.FormatSpec:1: WARNING: Block quote ends without a blank line; unexpected unindent.
aries_cloudagent/protocols/present_proof/v2_0/messages/pres_format.py:docstring of aries_cloudagent.protocols.present_proof.v2_0.messages.pres_format.FormatSpec:1: WARNING: Block quote ends without a blank line; unexpected unindent.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:8: ERROR: Unexpected indentation.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:11: ERROR: Unexpected indentation.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:5: WARNING: Definition list ends without a blank line; unexpected unindent.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:6: WARNING: Block quote ends without a blank line; unexpected unindent.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:19: ERROR: Unexpected indentation.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:11: WARNING: Definition list ends without a blank line; unexpected unindent.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:12: WARNING: Block quote ends without a blank line; unexpected unindent.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:25: ERROR: Unexpected indentation.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:30: ERROR: Unexpected indentation.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:20: WARNING: Block quote ends without a blank line; unexpected unindent.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:23: WARNING: Definition list ends without a blank line; unexpected unindent.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:24: WARNING: Block quote ends without a blank line; unexpected unindent.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:25: WARNING: Block quote ends without a blank line; unexpected unindent.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:40: ERROR: Unexpected indentation.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:43: ERROR: Unexpected indentation.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:37: WARNING: Definition list ends without a blank line; unexpected unindent.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:38: WARNING: Block quote ends without a blank line; unexpected unindent.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:52: ERROR: Unexpected indentation.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:58: ERROR: Unexpected indentation.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:48: WARNING: Block quote ends without a blank line; unexpected unindent.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:50: WARNING: Definition list ends without a blank line; unexpected unindent.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:51: WARNING: Block quote ends without a blank line; unexpected unindent.
aries_cloudagent/resolver/default/legacy_peer.py:docstring of aries_cloudagent.resolver.default.legacy_peer.LegacyDocCorrections:52: WARNING: Block quote ends without a blank line; unexpected unindent.

swcurran avatar Feb 16 '24 23:02 swcurran