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

Add documentation #65

Open
wants to merge 20 commits into
base: main
Choose a base branch
from
Open

Add documentation #65

wants to merge 20 commits into from

Conversation

codergeek42
Copy link
Owner

This is a first pass to add documentation and explanations as part of #53 .

This removes the multiple asterisks in their starting and ending markers, so that TSDoc will not (erroneously) attempt to parse them.
This removes the `IStrategyScoreMethod` and `INextWordGuesserStrategyBase` interfaces.

I initially planned to have multiple solver classes implementing the same pluggable interface, but I realized that most of the functionality to be shared would be the same; so it is better to extend a core abstract class instead, just differentiating on that unique `scoreForGuess` method.
This ensures that we run npx-using scripts (namely, lint) only after the install is done, not before.
@codergeek42 codergeek42 linked an issue Oct 22, 2024 that may be closed by this pull request
@codergeek42 codergeek42 self-assigned this Oct 22, 2024
@codergeek42 codergeek42 added the documentation Improvements or additions to documentation label Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant