example guide - minor cleanup

JetBrains / lincheck

Framework for testing concurrent data structures

Mozilla Public License 2.0

564 stars 33 forks source link

example guide - minor cleanup #144

Closed rendner closed 1 year ago

rendner commented 1 year ago

Hi, I read the lincheck-guide and noticed some minor problems. Most of them were missing imports and one non working example (didn't fail as specified).

Please have a look and let me know if any changes are needed.

ndkoval commented 1 year ago

Hi @rendner! We are now working on a new Lincheck API, and I will return to this PR once it is released. Is it OK for you?

rendner commented 1 year ago

Sure. Thanks for the feedback.

ndkoval commented 1 year ago

Hi, @rendner! We have recently updated the guide slightly, removing some unnecessary parts in particular. May I ask you to update the PR, please?

rendner commented 1 year ago

@ndkoval I updated the PR.

I recognized two things which should be double checked by you:

all links to the code examples in the guide markdown files point to the guide branch and not to the master
the previous failing example in the guide works now with lincheck v2.17 (see comment: 499dc0a), but the test in the guide doesn't exist anymore on the master branch

ndkoval commented 1 year ago

Fixes #188