Skip to content

docs: fix note on algorithm argument checking#158

Merged
johannaSommer merged 1 commit intomainfrom
docs/fix-check-note
Jun 11, 2025
Merged

docs: fix note on algorithm argument checking#158
johannaSommer merged 1 commit intomainfrom
docs/fix-check-note

Conversation

@johannaSommer
Copy link
Copy Markdown
Member

Description

This PR fixes a "tip" in the SmashConfig documentation, of which the behavior has recently changed. Before, you would have to specify a tokenizer first to activate an algorithm that requires one. Now, the order does not matter as the SmashConfig state is checked before the smash process begins.

Related Issue

None.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

None.

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Additional Notes

None.

Copy link
Copy Markdown
Member

@begumcig begumcig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTMM!!!

@johannaSommer johannaSommer merged commit 2447549 into main Jun 11, 2025
8 checks passed
@johannaSommer johannaSommer deleted the docs/fix-check-note branch June 11, 2025 11:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants