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

Add docstrings and pylint enforcement #96

Open
bpkroth opened this issue Sep 19, 2024 · 2 comments
Open

Add docstrings and pylint enforcement #96

bpkroth opened this issue Sep 19, 2024 · 2 comments
Assignees
@apavlen

Comments

@bpkroth
Copy link
Contributor

bpkroth commented Sep 19, 2024 

          @apavlen after this is merged, I think you can adjust the rules above this to find all the places that need docstrings and add the accordingly.

Originally posted by @bpkroth in #87 (comment)
@bpkroth
Copy link
Contributor Author

bpkroth commented Sep 19, 2024

To be done after #87 is merged.

@bpkroth
Copy link
Contributor Author

bpkroth commented Sep 19, 2024

And once this is done I think we can more easily tackle #62 and #94

This was referenced Sep 19, 2024
Open
Draft
@apavlen apavlen mentioned this issue Sep 24, 2024
Merged
apavlen added a commit that referenced this issue Sep 24, 2024
@apavlen
Fix docstrings for streamlit and recommender files (#118)
53e4461 
# Pull Request

## Title

Add module docstrings for streamlit files, recommenders and simulator
---

## Description

Fix docstring for streamlit files, recommenders and simulator

#96
---

## Type of Change

- 📝 Documentation update

Co-authored-by: “Anna <“[email protected]”>
@apavlen apavlen mentioned this issue Sep 27, 2024
Merged
apavlen added a commit that referenced this issue Sep 27, 2024
@apavlen
Add module docstrings (#123)
32aca6b 
# Pull Request

## Title

Add missing module-level docstrings 
---

## Description

This PR adds module-level docstrings to various Python files that were
previously missing documentation. The docstrings explain the purpose and
functionality of each module, which improves the readability and
maintainability of the codebase. Additionally, minor improvements were
made to existing docstrings to enhance clarity and consistency across
the codebase.

- **Issue link**:
(optional)[(#96)

---

## Type of Change

- 📝 Documentation update  

---

## Testing

unit tests
---

Co-authored-by: “Anna <“[email protected]”>
@apavlen apavlen mentioned this issue Oct 2, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@apavlen apavlen

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@apavlen @bpkroth