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.

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

[Controller] Controller Structure Prototype, DocStrings #56

Merged
merged 3 commits into from
Jul 12, 2021

Conversation

Rubix982
Copy link
Contributor

@Rubix982 Rubix982 commented Jul 12, 2021

This PR introduces basic function prototypes for controllers needed in controller/, each controller is created concerning each requirement, and has been labeled so. DocStrings are appropriately added, with a future PR relating to checking the correct keyword arguments to make sure nothing invalid is passed.

The above is meant to slightly mitigate, but not completely solve, the issue mentioned in #48 - @OmarMuhammedAli can this PR do more to help with it? This PR only shows the options on an exception, but not whenever a user might request help.

Integrates and includes changes introduced in #54.

This can serve as a basis for quickly iterating over the requirements independently.

Closes #55.

Compliments #57.

@Rubix982 Rubix982 added enhancement New feature or request requirements A requirement from the PRD controller Regarding controllers labels Jul 12, 2021
@Rubix982 Rubix982 self-assigned this Jul 12, 2021
@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 Jul 12, 2021
Copy link
Contributor

@OmarMuhammedAli OmarMuhammedAli left a comment

Choose a reason for hiding this comment

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

LGTM!

@Rubix982 Rubix982 merged commit 06a8c5b into main Jul 12, 2021
@Rubix982 Rubix982 deleted the Controller-Structure branch July 12, 2021 14:13
Copy link
Member

@cbeddow cbeddow left a comment

Choose a reason for hiding this comment

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

All clear to me, looks like setting the structure up for more to come

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. controller Regarding controllers enhancement New feature or request requirements A requirement from the PRD
Projects
MLH Fellowship
Awaiting triage
Development

Successfully merging this pull request may close these issues.

[Controller] Controller structure prototype needed
4 participants