Skip to content

[NFC] Use FileCheck for LTLSpec, use doc refs in LTL comments#5262

Merged
fabianschuiki merged 1 commit into
mainfrom
fschuiki/ltl-tweaks
Apr 9, 2026
Merged

[NFC] Use FileCheck for LTLSpec, use doc refs in LTL comments#5262
fabianschuiki merged 1 commit into
mainfrom
fschuiki/ltl-tweaks

Conversation

@fabianschuiki
Copy link
Copy Markdown
Contributor

Follow-up to #5260. Use proper ScalaDoc references in the doc comments of the LTL package. And switch the LTLSpec test over to use FileCheck.

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you add appropriate documentation in docs/src?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • Documentation or website-related
  • Internal or build-related (includes code refactoring/cleanup)

Desired Merge Strategy

  • Squash: The PR will be squashed and merged (choose this if you have no preference).

Release Notes

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels? (Select the most appropriate one based on the "Type of Improvement")
  • Did you mark the proper milestone (Bug fix: 3.6.x, 5.x, or 6.x depending on impact, API modification or big change: 7.0)?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you do one of the following when ready to merge:
    • Squash: You/ the contributor Enable auto-merge (squash) and clean up the commit message.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

Follow-up to #5260. Use proper ScalaDoc references in the doc comments
of the LTL package. And switch the LTLSpec test over to use FileCheck.
@fabianschuiki fabianschuiki requested a review from jackkoenig April 9, 2026 16:52
@fabianschuiki fabianschuiki added Documentation Only changing documentation Internal Internal change, does not affect users, will be included in release notes and removed Internal Internal change, does not affect users, will be included in release notes labels Apr 9, 2026
@jackkoenig
Copy link
Copy Markdown
Contributor

Thanks @fabianschuiki!

@fabianschuiki fabianschuiki merged commit 7439496 into main Apr 9, 2026
30 of 33 checks passed
@fabianschuiki fabianschuiki deleted the fschuiki/ltl-tweaks branch April 9, 2026 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Only changing documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants