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

Add a readme for the testexec extension and its conventions. #14

Merged
merged 2 commits into from
Nov 27, 2022

Conversation

warpfork
Copy link
Owner

This is a bit overdue :) Much of this was described in godocs or in comments in the code, but documentation deserves to be a little more discoverable than that!

@warpfork
Copy link
Owner Author

@TripleDogDare I'd love to request your review on this, since I think you've already become deeply familiar with it and will definitely spot any details that might be out of place :)

README.md Outdated Show resolved Hide resolved
testexec/README.md Outdated Show resolved Hide resolved
testexec/README.md Outdated Show resolved Hide resolved
testexec/README.md Outdated Show resolved Hide resolved
testexec/README.md Outdated Show resolved Hide resolved
testexec/README.md Outdated Show resolved Hide resolved
testexec/README.md Outdated Show resolved Hide resolved
testexec/README.md Outdated Show resolved Hide resolved
testexec/README.md Outdated Show resolved Hide resolved
@warpfork
Copy link
Owner Author

Wow. Thanks. I took all of those and expanded in the areas that needed fixes too. This got much better as a result.

testexec/README.md Outdated Show resolved Hide resolved
Some typo fixes.

Much more linking.

A few more configuration hooks get mentions.

Features have a pattern description before the literal example.

Examples are more completely narrated.

Added a whole section about script-vs-sequence (because the one tiny
paranthetical about that wasn't even close to enough).
@warpfork warpfork merged commit 5cd7a73 into master Nov 27, 2022
@warpfork warpfork deleted the testexec-docs branch November 27, 2022 03:22
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