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 discoverability of "rewriteToFile" option in ´Test´ #3345

Closed
AnnaKDS opened this issue Mar 19, 2019 · 4 comments · Fixed by #3360
Closed

Improve discoverability of "rewriteToFile" option in ´Test´ #3345

AnnaKDS opened this issue Mar 19, 2019 · 4 comments · Fixed by #3360
Assignees
@AnnaKDS
Labels
gapdays2019-spring Issues and PRs that arose at https://www.gapdays.de/gapdays2019-spring good first issue Issues that can be understood and addressed by newcomers to GAP development kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements topic: documentation Issues and PRs related to documentation

Comments

@AnnaKDS
Copy link

AnnaKDS commented Mar 19, 2019

This issue is suggested by @ssiccha.

The "rewriteToFile" option is very useful for generating lots of tests and should be more visible for users. An example also might be helpful.
@AnnaKDS AnnaKDS changed the title Improve discoverability of "rewriteToFile" option in Test Improve discoverability of "rewriteToFile" option in ´Test´ Mar 19, 2019
@ChrisJefferson
Copy link
Contributor

Just in case you didn't know, the same option also exists on TestDirectory, to rewrite even more files at the same time

@ssiccha ssiccha added kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements good first issue Issues that can be understood and addressed by newcomers to GAP development topic: documentation Issues and PRs related to documentation gapdays2019-spring Issues and PRs that arose at https://www.gapdays.de/gapdays2019-spring labels Mar 19, 2019
@fingolfin
Copy link
Member

Could you say how you'd imagine it could be made more "visible"?

@AnnaKDS
Copy link
Author

AnnaKDS commented Mar 20, 2019

I can imagine that if "rewriteToFile" was mentioned as one of the first options then it'd be more visible for users. Also the description is very short and doesn't explicitly say in which case you can use this option. Would that be ok?

@AnnaKDS AnnaKDS mentioned this issue Mar 20, 2019
Merged
@markuspf
Copy link
Member

I wonder whether that elusive new GAP webpage (or at least the documentation of GAP) should feature a tutorial on how to write a package (or even just how to write tests).

@ChrisJefferson used to have something similar on his webpage, but a bit slightly more "formal" might be good.

fingolfin pushed a commit that referenced this issue Mar 21, 2019
@fingolfin
Improve discoverability of "rewriteToFile" option in "Test"
e3ac220 
Fixes #3345
ssiccha pushed a commit to ssiccha/gap that referenced this issue Mar 27, 2019
@ssiccha
Improve discoverability of "rewriteToFile" option in "Test"
2019077 
Fixes gap-system#3345
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AnnaKDS AnnaKDS

Labels
gapdays2019-spring Issues and PRs that arose at https://www.gapdays.de/gapdays2019-spring good first issue Issues that can be understood and addressed by newcomers to GAP development kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements topic: documentation Issues and PRs related to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve discoverability of "rewriteToFile" option in "Test"
5 participants
@fingolfin @ChrisJefferson @markuspf @ssiccha @AnnaKDS