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 documentation section about adding new languages #787

Merged
merged 2 commits into from
Nov 4, 2024
Merged

Conversation

nbacquey
Copy link
Member

@nbacquey nbacquey commented Oct 30, 2024

Description

This PR adds a documentation section about supporting a new language to Topiary, and updates the "Suggested workflow" section to reflect the latest state of the code base.

It also reinstates the option to have "verbose" tests with --nocapture, which was removed during #643.

Closes #652

Checklist

Checklist before merging:

  • CHANGELOG.md updated
  • README.md up-to-date

@nbacquey nbacquey force-pushed the nb/doc branch 5 times, most recently from 223a88c to 1cd5544 Compare October 31, 2024 15:23
@nbacquey nbacquey changed the title WIP: Update documentation Add documentation section about adding new languages Oct 31, 2024
@nbacquey nbacquey marked this pull request as ready for review October 31, 2024 15:28
@nbacquey nbacquey requested a review from Xophmeister October 31, 2024 15:48
Copy link
Member

@Xophmeister Xophmeister 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 🙏

I made a few minor suggestions, but not enough to block.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@nbacquey nbacquey merged commit 4e08674 into main Nov 4, 2024
8 checks passed
@nbacquey nbacquey deleted the nb/doc branch November 4, 2024 11:07
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.

The "Suggested Workflow" documentation is out-of-date
3 participants