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

Edit paper - result of write-good suggestions #14

Merged
merged 2 commits into from
May 11, 2022

Conversation

cooperrc
Copy link
Contributor

I added suggested edits to avoid passive voice and make the paper a little clearer (its really great, just some minor preferences on my part)

One thing that really stood out L181:

The user can implement any control policy by creating a new class
[??link to docs??](https://github.com/openjournals/jose-reviews/issues/168). Users
can test new open-ended controller designs.  Controllers can dump data
into the simulation results so that intermediate control inputs are
accessible to the final results of the simulation.

It would be great to document how the user can implement and contribute to this ongoing project. If one person builds a neural network trainer out of this, how can they contribute to the original repo? or should they?

Copy link
Owner

@rland93 rland93 left a comment

Choose a reason for hiding this comment

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

Looks good, thanks! I thought I had caught all of the passive voice in here. Passive voice in scientific communication drives me up the wall too.

@rland93 rland93 merged commit 7a99357 into rland93:main May 11, 2022
@cooperrc
Copy link
Contributor Author

Awesome!

Glad you appreciate the work. Some people like to add passive voice, but I prefer active especially for technical + scientific docs

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

Successfully merging this pull request may close these issues.

2 participants