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

Improve illustration/example of how to share code segment context #53

Open
bielsnohr opened this issue Mar 18, 2022 · 0 comments
Open

Comments

@bielsnohr
Copy link
Collaborator

I think this could be tightened up a bit and made more concrete. At the moment it is a touch on the vague side. I am thinking of something like the specific examples we were writing a while ago with the individual step recipes. Rough first pass:

Lisa is writing a library for molecular interactions and has a class in her code to represent a molecule. She has recently added a few methods like get_position(), get_velocity(), find_nearest_neighbours() and she wants to make sure the code is readable and conforms to Python standards. When she shares the class and methods with her reviewer, this is the context she provides: ... (fill in)

Originally posted by @bielsnohr in #50 (comment)

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

No branches or pull requests

1 participant