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

docs: build_tb: Add Edit a Testbench Efficiently #157

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

gastmaier
Copy link
Contributor

@gastmaier gastmaier commented Jan 13, 2025

PR Description

This section consists in a few tips and nudges to improve the developer experience when writing tbs.
Rename test bench to testbench.

Happy to see contributions to this PR.

PR Type

  • Bug fix (change that fixes an issue)
  • New feature (change that adds new functionality)
  • New test (change that adds new test program and/or testbench)
  • Breaking change (has dependencies in other repositories/testbenches)

PR Checklist

  • I have followed the code style guidelines
  • I have performed a self-review of changes
  • I have ran all testbenches affected by this PR
  • I have commented my code, at least hard-to-understand parts
  • I have signed off all commits from this PR
  • I have updated the documentation (wiki pages, ReadMe files, Copyright etc)
  • I have not introduced new Warnings/Errors on compilation/elaboration/simulation
  • I have set the verbosity level to none for the test program

This section consists in a few tips and nudges to improve the developer
experience when writing tbs.
Rename test bench to testbench.

Signed-off-by: Jorge Marques <[email protected]>
Copy link
Contributor

@IstvanZsSzekely IstvanZsSzekely left a comment

Choose a reason for hiding this comment

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

I like this option of having an Edit a testbench section. Showing the user how to modify any testbench or source file is something that will be very useful down the road.
I think that this could have its own separate page too.
I have some ideas to add to this documentation as well.

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