Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Classes and functions docstrings #195

Closed
peppelinux opened this issue Dec 1, 2023 · 3 comments
Closed

Classes and functions docstrings #195

peppelinux opened this issue Dec 1, 2023 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement Something improving existing features
Milestone

Comments

@peppelinux
Copy link
Member

We need to document each class, method and function with a structure similar to what we have for the backend class

"""
        OpenID4VP backend module.
        :param auth_callback_func: Callback should be called by the module after the authorization
        in the backend is done.
        :param internal_attributes: Mapping dictionary between SATOSA internal attribute names and
        the names returned by underlying IdP's/OP's as well as what attributes the calling SP's and
        RP's expects namevice.
        :param config: Configuration parameters for the module.
        :param base_url: base url of the service
        :param name: name of the plugin
        :type auth_callback_func:
        (satosa.context.Context, satosa.internal.InternalData) -> satosa.response.Response
        :type internal_attributes: dict[string, dict[str, str | list[str]]]
        :type config: dict[str, dict[str, str] | list[str]]
        :type base_url: str
        :type name: str
        """
@peppelinux peppelinux added documentation Improvements or additions to documentation enhancement Something improving existing features labels Dec 1, 2023
@peppelinux peppelinux added this to the 0.8.0 milestone Dec 1, 2023
@peppelinux
Copy link
Member Author

Then extract and create the API documentation here
https://github.com/italia/eudi-wallet-it-python#usage

@peppelinux peppelinux reopened this Dec 1, 2023
@github-project-automation github-project-automation bot moved this from Todo to Done in EUDI WALLET IT Python Dec 1, 2023
@peppelinux peppelinux moved this from Done to Todo in EUDI WALLET IT Python Dec 1, 2023
@peppelinux peppelinux moved this from Todo to In Progress in EUDI WALLET IT Python Dec 7, 2023
@davidelongo-ey
Copy link

davidelongo-ey commented Dec 7, 2023

More info about task WiP:

using docstring rst format:

  • sphinx command (+ update readme informations)
  • CD (Github pages + Gtihub Actions)
  • Readme update (sphinx command + API documentation)

@PascalDR

@peppelinux
Copy link
Member Author

Done here #205

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement Something improving existing features
Projects
Status: Done
Development

No branches or pull requests

3 participants