Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Fix documentation of configuring table_name #216

Merged
merged 1 commit into from
Jul 27, 2024

Conversation

elazar
Copy link
Contributor

@elazar elazar commented Jul 26, 2024

This example references the setting store.table_name, but using this setting causes an error to be emitted.

Unrecognized option "table_name" under "patchlevel_event_sourcing.store". Available
options are "merge_orm_schema", "options".

It appears this example should reference store.options.table_name instead; doing so avoids the above error. This also appears to be corroborated by discrepancies elsewhere in the codebase, specifically here and here.

@DanielBadura
Copy link
Member

Yes this is wrong documented. Could you change the target to 3.0.x? Then the docs are updated there too. Thank you.

@DanielBadura DanielBadura added the documentation Improvements or additions to documentation label Jul 27, 2024
@elazar elazar changed the base branch from 3.3.x to 3.0.x July 27, 2024 14:58
Referenced setting is store.table_name but should be store.options.table_name.
@elazar
Copy link
Contributor Author

elazar commented Jul 27, 2024

Yes this is wrong documented. Could you change the target to 3.0.x? Then the docs are updated there too. Thank you.

Done. Thank you! 🙏

@DanielBadura DanielBadura changed the title Correct referenced setting in "Change table Name" example in Configuration section Fix documentation of configuring table_name Jul 27, 2024
@DanielBadura DanielBadura merged commit 6b37bf8 into patchlevel:3.0.x Jul 27, 2024
19 checks passed
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants