Skip to content

Add type annotations, docstrings and documentation #23

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
Merged
merged 4 commits into from
Aug 7, 2023
Merged

Add type annotations, docstrings and documentation #23

merged 4 commits into from
Aug 7, 2023

Conversation

@chahak13
Copy link
Collaborator

@chahak13 chahak13 commented Jul 9, 2023 •
edited
Loading

Closes #20

@chahak13 chahak13 changed the title Add type annotations, docstrings Add type annotations, docstrings and documentation Jul 9, 2023
@chahak13 chahak13 marked this pull request as ready for review July 14, 2023 03:47
@chahak13 chahak13 mentioned this pull request Jul 16, 2023
Draft
kks32
kks32 requested changes Jul 20, 2023
View reviewed changes
Copy link
Contributor

@kks32 kks32 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you use to generate documentation? Should we automate it in .github/workflows?

Otherwise I'm OK.

kks32
kks32 reviewed Jul 20, 2023
View reviewed changes
@chahak13
Copy link
Collaborator Author

I'm currently using pdoc3 for the link that I shared but I'm not sure if we want to continue using that or move to sphinx maybe. But yes, will definitely want to add that workflow. Maybe can make that as another PR and get that in for now?

@chahak13 @kks32
Update README.md
5021c3b 
Co-authored-by: Krishna Kumar <3963513+kks32@users.noreply.github.com>
@chahak13 chahak13 merged commit 8bb0bb3 into geoelements:main Aug 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kks32 kks32 kks32 requested changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Update documentation

2 participants

@chahak13 @kks32