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

Small update to Type checks and casts page #3710

Merged
merged 1 commit into from
Aug 24, 2023
Merged

Conversation

sarahhaggarty
Copy link
Collaborator

This PR updates the Type checks and casts page to make it clear earlier in the page that generics documentation is available on another page. Other changes have been added, like an introduction and other modifications, to tidy up the page a bit.

This PR resolves KT-57270.

@sarahhaggarty sarahhaggarty requested review from danil-pavlov and removed request for koshachy August 17, 2023 13:37
Copy link
Contributor

@danil-pavlov danil-pavlov left a comment

Choose a reason for hiding this comment

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

Nice update! I'm just wondering why you opted for an xml table instead of Markdown? We usually try to use md syntax because it's more readable except for special cases when it's not enough
Is it because of the necessary table header in md tables? You can still add something like Element | Condition at the top of the table

@sarahhaggarty
Copy link
Collaborator Author

Nice update! I'm just wondering why you opted for an xml table instead of Markdown? We usually try to use md syntax because it's more readable except for special cases when it's not enough Is it because of the necessary table header in md tables? You can still add something like Element | Condition at the top of the table

Thanks @danil-pavlov ! Yes, it's because I wanted to use a table without a header, which is only possible via XML right now. Originally this was just a bulleted list but I think it is easier to read in a table format. I couldn't find header names that I liked unfortunately. Even "element" doesn't seem relevant enough to me for the first column 🤔 Is it OK to stick with the XML or could you help me find better header names?

@danil-pavlov
Copy link
Contributor

I like the table idea and I can't come up with anything better than "Variables and properties", so let's keep the XML table as is

@sarahhaggarty sarahhaggarty merged commit 68fdabb into master Aug 24, 2023
3 checks passed
@sarahhaggarty sarahhaggarty deleted the type-checks-casts branch August 24, 2023 12:03
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.

2 participants