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

Improve documentation of JSON argument source #621

Closed
nipafx opened this issue Apr 11, 2022 · 2 comments
Closed

Improve documentation of JSON argument source #621

nipafx opened this issue Apr 11, 2022 · 2 comments

Comments

@nipafx
Copy link
Member

nipafx commented Apr 11, 2022

Two things:

  • reduce code snippet line length to max ~60, so they fit into the narrow code boxes on the website (i.e. no horizontal scroll bar)
  • explain how parser integration works:
    • so far only Jackson
    • it's an optional dependency, so if you want to use the extension, you need to do $THING_A in Gradle (feature variant) and $THING_B in Maven (just add dependency, I think) - see https://github.com/junit-pioneer/junit-pioneer-demo/tree/jackson-feature (and update/merge that branch into main while at it)
    • if you're using modules but have no dependency on Jackson, add requires ...jackson to module descriptor or --add-module to test runtime so it makes it into module graph
  • mention that text blocks work
@Bukama
Copy link
Member

Bukama commented Apr 11, 2022

Max line length is 60 (see #317)

@nipafx
Copy link
Member Author

nipafx commented Apr 12, 2022

@Bukama Thanks, updated the description.

@nipafx nipafx added this to the Busy Pioneers - V2.0 milestone Apr 28, 2022
nipafx pushed a commit that referenced this issue May 13, 2022
* mention that text blocks work
* reduce code snippet line length to max ~60, so they fit into the
  narrow code boxes on the website (i.e. no horizontal scroll bar)
* explain parser integration work:
	* so far only Jackson
	* optional dependency
	* force module resolution
@nipafx nipafx closed this as completed in 9bd6f03 May 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants