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

Pode.Web Source Code Missing Comments; Synopsis; & Discriptions that are Present in Pode Source Code #603

Open
jbaechtelMT opened this issue Jul 29, 2024 · 0 comments
Labels
documentation 📖 Improvements or additions to documentation

Comments

@jbaechtelMT
Copy link

jbaechtelMT commented Jul 29, 2024

Describe the Change

The Pode module's source code has Comments; Synopsis; and Descriptions that the source code for Pode.Web does not. Wanted to raise a documentation request so that I can do a pull request against it so that I can help get this in place.

Additional Context

Now that I have developed scripts to launch Pode from YAML Config files and its' companion script that reads the Pode and Pode.Web module's script files and creates YAML representation file(s) for each of the functions contained within, there is (documentation: Comments; Synopsis; and Descriptions) missing from the YAML output files because it doesn't exist in the sources files.

I would like to help get that information in place for my scripts to use as self documentation with the YAML.

@jbaechtelMT jbaechtelMT added the documentation 📖 Improvements or additions to documentation label Jul 29, 2024
@jbaechtelMT jbaechtelMT changed the title Pode.Web Documentation Missing Comments; Synopsis; & Discriptions from Source Code Pode.Web Source Code Missing Comments; Synopsis; & Discriptions that are Present in Pode Source Code Jul 29, 2024
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
Projects
Status: Backlog
Development

No branches or pull requests

1 participant