testcontainers / testcontainers/testcontainers-java

Rendered JUnit 4 quickstart documentation page contains `inside_block`

Open
#1,415 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

resolution/acknowledged type/docs
Dominant language
Java
Stars
8.7k
Forks
1.9k
Avg merge
2d 17h
Merged PRs (30d)
9

Description

The code example "4. Run the tests!" under JUnit 4 Quickstart page contains an unevaluated inside_block reference. Readers will likely find this confusing. I am wondering if you can configure the documentation engine to exclude rendering "nested" block references.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the JUnit 4 Quickstart page and inspect the "4. Run the tests!" example where inside_block is rendered literally. Trace that example through the documentation engine to determine how nested block references are handled, then verify that the published page no longer shows the unevaluated reference.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.