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

Styling docs #7455

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Styling docs #7455

wants to merge 3 commits into from

Conversation

zoran995
Copy link
Collaborator

@zoran995 zoran995 commented Feb 7, 2025

What this PR does

Fixes #7352 - first part

Update documentation on data styling to align with changes made in v8.

Test me

Doc only change

Checklist

  • [ ] There are unit tests to verify my changes are correct or unit tests aren't applicable (if so, write quick reason why unit tests don't exist) doc only change
  • I've updated relevant documentation in doc/.
  • I've updated CHANGES.md with what I changed.
  • [ ] I've provided instructions in the PR description on how to test this PR. doc only change

@zoran995 zoran995 requested review from ljowen and nf-s February 7, 2025 21:06
@@ -59,6 +59,7 @@ export default class TableColumnTraits extends ModelTraits {
"The type of the column. If not specified, the type is guessed from " +
"the column's name and values. Valid types are:\n\n" +
Object.keys(TableColumnType)
.filter((type) => isNaN(Number(type)))
Copy link
Collaborator Author

@zoran995 zoran995 Feb 7, 2025

Choose a reason for hiding this comment

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

Filter out numeric values from enum keys. Maybe those works, but they aren't useful for users as changes in the enum can break them easily

Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps that information should be put in a comment in the source code so it's easily available for future readers?

Comment on lines +124 to +125
"type": "dateTime";
"format": "dd-mm-yyyy HH:MM:ss";
Copy link
Contributor

Choose a reason for hiding this comment

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

Are the ending semicolons meant to be commas?

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.

Review / Update Data styling and architecture section of docs
2 participants