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

Docstrings for files #450

Merged
merged 6 commits into from
Apr 3, 2024
Merged

Docstrings for files #450

merged 6 commits into from
Apr 3, 2024

Conversation

sklbancor
Copy link
Collaborator

@sklbancor sklbancor commented Mar 20, 2024 •
edited
Loading

Fixes #438

Adds doc strings to all files that do not have them

All files should have a docstring of the following format

"""
[DOC-TODO-short description of what the file does, max 80 chars]

[DOC-TODO-OPTIONAL-longer description in rst format]

---
(c) Copyright Bprotocol foundation 2023-24.
All rights reserved.
Licensed under MIT.
"""

@sklbancor sklbancor self-assigned this Mar 20, 2024
@sklbancor sklbancor added clean-up non-functional changes that improve code quality documentation Improvements or additions to documentation labels Mar 20, 2024
@sklbancor sklbancor force-pushed the 438-docstrings-for-files branch 4 times, most recently from 1d00c5f to 3e661ed Compare March 20, 2024 23:34
@sklbancor sklbancor force-pushed the 438-docstrings-for-files branch 2 times, most recently from 56c0538 to d1193e8 Compare April 3, 2024 12:02
sklbancor
sklbancor commented Apr 3, 2024
View reviewed changes
BRANCH_438_DOCSTRINGS Outdated Show resolved Hide resolved
@sklbancor sklbancor marked this pull request as ready for review April 3, 2024 12:10
@sklbancor sklbancor requested review from barakman and zavelevsky and removed request for mikewcasale April 3, 2024 12:11
@zavelevsky zavelevsky merged commit 5b4219c into develop Apr 3, 2024
3 checks passed
@zavelevsky zavelevsky deleted the 438-docstrings-for-files branch April 3, 2024 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zavelevsky zavelevsky zavelevsky approved these changes

@Lesigh-3100 Lesigh-3100 Awaiting requested review from Lesigh-3100

@barakman barakman Awaiting requested review from barakman

Assignees

@sklbancor sklbancor

Labels
clean-up non-functional changes that improve code quality documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

All files should have doc strings
2 participants
@sklbancor @zavelevsky