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

Improve Docstrings in aepsych/models #423

Closed
wants to merge 12 commits into from
Closed

Improve Docstrings in aepsych/models #423

wants to merge 12 commits into from

Conversation

yalsaffar
Copy link
Contributor

Improves documentation in aepsych/models for better clarity and consistency.

  • Adds missing docstrings to functions and methods across all models.
  • Updates existing docstrings with refined type hints and a unified structure.

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Oct 31, 2024
JasonKChow
JasonKChow requested changes Oct 31, 2024
View reviewed changes
Copy link
Contributor

@JasonKChow JasonKChow left a comment

Choose a reason for hiding this comment

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

Some feedback in comment, two of which affects everything. Let me know when those changes are in to review other PRs.

aepsych/models/base.py Outdated Show resolved Hide resolved
aepsych/models/base.py Show resolved Hide resolved
aepsych/models/base.py Outdated Show resolved Hide resolved
aepsych/models/base.py Outdated Show resolved Hide resolved
aepsych/models/base.py Show resolved Hide resolved
aepsych/models/gp_regression.py Show resolved Hide resolved
aepsych/models/pairwise_probit.py Outdated Show resolved Hide resolved
aepsych/models/pairwise_probit.py Show resolved Hide resolved
JasonKChow
JasonKChow approved these changes Nov 5, 2024
View reviewed changes
Copy link
Contributor

@JasonKChow JasonKChow left a comment

Choose a reason for hiding this comment

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

Need rebase.

JasonKChow
JasonKChow requested changes Nov 7, 2024
View reviewed changes
Copy link
Contributor

@JasonKChow JasonKChow left a comment

Choose a reason for hiding this comment

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

Small changes and we'll be ready.

aepsych/models/base.py Show resolved Hide resolved
aepsych/models/gp_classification.py Outdated Show resolved Hide resolved
aepsych/models/utils.py Show resolved Hide resolved
JasonKChow
JasonKChow requested changes Nov 11, 2024
View reviewed changes
Copy link
Contributor

@JasonKChow JasonKChow left a comment

Choose a reason for hiding this comment

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

Need rebase

JasonKChow
JasonKChow previously approved these changes Nov 12, 2024
View reviewed changes
@JasonKChow JasonKChow dismissed their stale review November 12, 2024 02:04

ope still need rebase

JasonKChow
JasonKChow requested changes Nov 12, 2024
View reviewed changes
Copy link
Contributor

@JasonKChow JasonKChow left a comment

Choose a reason for hiding this comment

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

Rebase then good.

@facebook-github-bot
Copy link
Contributor

@JasonKChow has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

crasanders
crasanders requested changes Nov 14, 2024
View reviewed changes
Copy link
Contributor

@crasanders crasanders left a comment

Choose a reason for hiding this comment

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

Just make that small change to the sample docstrings, and I think this is ready.

aepsych/models/pairwise_probit.py Outdated Show resolved Hide resolved
@facebook-github-bot
Copy link
Contributor

@JasonKChow has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

@facebook-github-bot
Copy link
Contributor

@JasonKChow merged this pull request in d9d4eff.

JasonKChow pushed a commit that referenced this pull request Nov 25, 2024
@yalsaffar @JasonKChow
Improve Docstrings in aepsych/models (#423)
d6fbaf6 
Summary:
Improves documentation in `aepsych/models` for better clarity and consistency.

- Adds missing docstrings to functions and methods across all models.
- Updates existing docstrings with refined type hints and a unified structure.

Pull Request resolved: #423

Reviewed By: crasanders

Differential Revision: D65858741

Pulled By: JasonKChow

fbshipit-source-id: e10d788a0d271838157a6dc421052369ff02ff9e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JasonKChow JasonKChow JasonKChow approved these changes

@crasanders crasanders Awaiting requested review from crasanders

Assignees
No one assigned
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. Merged
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@yalsaffar @facebook-github-bot @crasanders @JasonKChow