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

Incorrect Data Types in Accessing Generated Sudoku Documentation #16

Closed
teogor opened this issue Aug 25, 2023 · 0 comments · Fixed by #21
Closed

Incorrect Data Types in Accessing Generated Sudoku Documentation #16

teogor opened this issue Aug 25, 2023 · 0 comments · Fixed by #21
Assignees
Labels
@bug Something isn't working @documentation Improvements or additions to documentation @priority-high
Milestone

Comments

@teogor
Copy link
Owner

teogor commented Aug 25, 2023

In the documentation section for "Accessing Generated Sudoku," there is a discrepancy between the stated data types of puzzleString and solutionString and their actual data types. The documentation suggests that both puzzleString and solutionString are of type String, but they are actually of type Board.

This inconsistency could lead to confusion for developers trying to access and utilize the generated Sudoku properties correctly. To address this, we should update the documentation to accurately reflect that puzzleString and solutionString are of type Board.

Here is the corrected version of the code snippet and explanation:

val puzzleBoard = generatedSudoku.puzzle
val solutionBoard = generatedSudoku.solution
val difficulty = generatedSudoku.difficulty
val type = generatedSudoku.type

// Print the properties
println("Puzzle Board: $puzzleBoard")
println("Solution Board: $solutionBoard")
println("Difficulty: $difficulty")
println("Grid Type: $type")

This update will ensure that developers have accurate information when working with the generated Sudoku properties.

@teogor teogor added @bug Something isn't working @documentation Improvements or additions to documentation @priority-high labels Aug 25, 2023
@teogor teogor added this to the 1.0.0-alpha02 milestone Aug 25, 2023
@teogor teogor self-assigned this Aug 25, 2023
@teogor teogor linked a pull request Aug 25, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@bug Something isn't working @documentation Improvements or additions to documentation @priority-high
Projects
Development

Successfully merging a pull request may close this issue.

1 participant