dyc
dyc copied to clipboard
Zarad1993
Python prefixed formats
We have a default config file for defining formats. It would be nice to create known formats and reference them in our dyc.yaml file.
Usage
dyc.yaml
Just an idea
-
extension: py
style: sphinx/google/numpy
Then it would follow the known style format of sphinx or google or numpy
We can have these files in defaults for references
configs/{{style}}.yaml
That way it would be easier for a project to set docstrings standards based on a style
I am interested in this. May I take a look? @Zarad1993 . Just help me out in case I need assistance
Can you pls go ahead and detail the issue. What exactly do you require, and which portion of codebase do i need to go through. Btw, I am using dyc in my new python project! @Zarad1993
That's great. Sure I'll add some more details soon. The high-level idea is to add some fixed templates, so instead of customizing it. You can choose pre-existing ones. This is an example of a sphinx ones https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html
Cool, so I am going to add sphinx docstring format initially, and if that's successful, I will introduce NumPy and Google style. @Zarad1993
Yes, then instead of having to define these formats manually in your project. You can just extend it to use them across the board.
I really apologize for the impossible delay. I took some time to understand the project, and then caught busy with other stuffs. Please review the PR. @Zarad1993
the default format given for DYC is only documenting the function and the parameters. But it doesn't specify a format for a class and errors that the function is raising. The class is under progress, as given in the README. What about errors?
Is this issue still open? I would like to work on this issue. Can you please assign this to me?
