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

Write additional comments within files #3

Open
elijahverdoorn opened this issue Oct 3, 2019 · 0 comments
Open

Write additional comments within files #3

elijahverdoorn opened this issue Oct 3, 2019 · 0 comments
Labels
good first issue Good for newcomers

Comments

@elijahverdoorn
Copy link
Collaborator

The purpose of this repo is education - thus far developers using the samples are largely expected to be able to read the source code and infer what's intended in each sample. We ought to add comments describing the situation that each file is assuming, and how it responds to those scenarios.

We can perhaps leverage a given/when/then pattern for these inline comments?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant