-
Notifications
You must be signed in to change notification settings - Fork 408
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
Move the Properties block to be above Functions #2908
Conversation
Could you please show how documentation (any lib will work, not necessarily datetime) looks after the change? |
57686db
to
08f77ef
Compare
BasicTabbedContentType.PROPERTY, | ||
BasicTabbedContentType.FUNCTION |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changing the order here doesn't actually do anything, so it's just for consistency
If you want a live demo to be able to click around:
But the link is dynamic based on the latest commit, and one branch can only have one live preview, so it's not permanent. These previews are also published to GitHub artifacts as zip archives. If the goal is to preserve context / improve description, I can certainly make a screenshot or upload the live preview to a more permanent hosting, just let me know Had to change the order of the actual blocks, updated and force-pushed the branch |
I've skimmed through the generated documentation, few things caught my eye (I'm not sure they are relevant to this PR, though, so feel free to proceed):
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Semantically, the change looks good (better and more natural than it was 👍).
It would be nice to have some tests on it or documentation though, so any accidental order change will lead to a build failure
BasicTabbedContentType.PROPERTY, | ||
BasicTabbedContentType.FUNCTION, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would be nice to drop a comment about the order's meaning and why the order is the way it is
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately, here the order doesn't make any difference, even though I expected it would :( Here it's purely cosmetic and I made the change for consistency. Something tells me leaving a comment like that here could be confusing down the road..
I'll write the tests for the true order though
I've looked at the links and I don't see what's wrong :( Maybe there's something wrong with the cached styles or something? The "properties" tab is not empty for me and all links work for me, not sure which one exactly you mean and how pressing the "common" selector can help with it :( I'll try to remember to bring it up during one of the syncs, but I might forget |
08f77ef
to
0a97005
Compare
Current (that is, before this change) behaviour could be seen here: kotlinx-datetime#Instant