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

Add Examples to Format Description #2

Closed

Conversation

naftulikay
Copy link

I had a hard time understanding how to apply the format descriptions, so I have added an example here in addition to adding the field names to each of the list items to make Ctrl+F easier for finding what you are looking for.

Comment on lines +66 to +68
"[weekday repr:short], [day padding:zero] [month repr:short] [year repr:full] \
[hour repr:24 padding:zero]:[minute padding:zero]:[second padding:zero] \
[offset_hour padding:zero]:[offset_minute padding:zero]"
Copy link
Member

Choose a reason for hiding this comment

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

It would be preferable to omit the modifiers that are default. Without checking I think all of ones specified here are.

Copy link
Author

Choose a reason for hiding this comment

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

So the main issue that I had reading the documentation was trying to understand how to apply modifiers at all. The state diagrams were initially confusing but I was able to figure it out by iterating on it. Maybe I should give an example that uses a different format to show how modifiers work? The main thing I'd like to see demonstrated is >1 modifier for a given component.

Copy link
Member

Choose a reason for hiding this comment

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

Ah, I gotcha. Yes, a separate example would probably be clearer.

Thank you for the additions, by the way! Every bit helps.

@jhpratt
Copy link
Member

jhpratt commented Aug 1, 2022

Hey @naftulikay, would you mind making the other change requested? Then this can be merged.

@jhpratt
Copy link
Member

jhpratt commented Feb 9, 2023

Closing due to inactivity.

@jhpratt jhpratt closed this Feb 9, 2023
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