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.

Sign up for GitHub

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

Jump to bottom

Document public facing API #1073

Merged
merged 10 commits into from Apr 30, 2021
Merged

Document public facing API #1073

merged 10 commits into from Apr 30, 2021

Conversation

JerrettDavis
Copy link
Contributor

@JerrettDavis JerrettDavis commented Apr 29, 2021 •
edited by FabianGosebrink

Documented the publicly facing API.

#1071

Can we tackle #1072 in here as well? Return types can be part of the docs as well, would like to add that in one go.

@JerrettDavis JerrettDavis marked this pull request as ready for review April 30, 2021 00:53
@JerrettDavis
Copy link
Contributor Author

I have documented the entirety of the public API and the configuration. I have also added return types to all applicable fields and methods.

@damienbod
Copy link
Owner

@JerrettDavis LGTM, just 3 comments

Greetings Damien

@damienbod damienbod merged commit debcb33 into damienbod:main Apr 30, 2021
@JerrettDavis JerrettDavis deleted the feature/start-documenting-code branch April 30, 2021 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@damienbod damienbod damienbod left review comments

@FabianGosebrink FabianGosebrink FabianGosebrink approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@JerrettDavis @damienbod @FabianGosebrink