chipsalliance / chipsalliance/chisel-template

The GCDSpec test class comment document and the class name are inconsistent

Open
#88 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Shell
Stars
708
Forks
203
PR merge metrics
No merged PRs in 30d

Description

The GCDSpec test class comment document:
```
/**
* This is a trivial example of how to run this Specification
* From within sbt use:
* {{{
* testOnly gcd.GcdDecoupledTester
* }}}
* From a terminal shell use:
* {{{
* sbt 'testOnly gcd.GcdDecoupledTester'
* }}}
*/
```
the class `GCDSpec` should be named `GcdDecoupledTester`
or change the comment
`testOnly gcd.GcdDecoupledTester` to `testOnly gcd.GCDSpec`

Contributor guide

No contributing guide indexed for this repository

Research direction

Locate the GCDSpec test class and read its documentation comment. Make the class name and the documented testOnly target agree, then verify that the documented command targets the intended test.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation, testing
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.