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

Dataclass attributes not documented #8

Open
edmorley opened this issue Jan 13, 2023 · 0 comments
Open

Dataclass attributes not documented #8

edmorley opened this issue Jan 13, 2023 · 0 comments

Comments

@edmorley
Copy link

edmorley commented Jan 13, 2023

Hi

I tried using mkgendocs with a project that uses dataclasses, however the output was missing all of the dataclass attributes.

For example, the Context dataclass here:
https://github.com/heroku/sf-functions-python/blob/3d3b16abc76bde98718fa053f1226fdc4a7052f9/salesforce_functions/context.py#L36-L41

...was documented as:

## Context
\```python 
Context()
\```


---
Information relating to the function and the Salesforce org with which it is associated.

...the org attribute is missing, and also the Context() function signature is missing all arguments present in the generated constructor.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant