Skip to content

Make the README less misleading by putting some reasonable defaults in (instead of empty strings '')#302

Merged
DilumAluthge merged 6 commits intomasterfrom
dpa/readme
Dec 16, 2024
Merged

Make the README less misleading by putting some reasonable defaults in (instead of empty strings '')#302
DilumAluthge merged 6 commits intomasterfrom
dpa/readme

Conversation

@DilumAluthge
Copy link
Copy Markdown
Member

No description provided.

@IanButterworth
Copy link
Copy Markdown
Member

Probably do the same for the version too?

@DilumAluthge
Copy link
Copy Markdown
Member Author

Probably do the same for the version too?

Yeah. But what do we want to put in there?

@IanButterworth
Copy link
Copy Markdown
Member

The default? "1" note the "'s

@DilumAluthge DilumAluthge requested review from IanButterworth and removed request for IanButterworth November 18, 2024 18:54
IanButterworth
IanButterworth previously approved these changes Nov 18, 2024
Comment on lines 71 to 72
#
# Default: false
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
#
# Default: false

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Hmmm. I'm a bit conflicted on this. I don't know if the following line (show-versioninfo: 'false') makes it sufficiently clear that false is the default value. I think I'd probably lean towards keeping the line that clarifies that false is the default value.

Comment on lines 42 to 43
#
# Default: '1'
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
#
# Default: '1'

@DilumAluthge
Copy link
Copy Markdown
Member Author

@IanButterworth Any idea why those two CI checks are showing up as "cancelled".

@DilumAluthge
Copy link
Copy Markdown
Member Author

Hmmm. Those two jobs keep showing up as canceled, and thus I cannot merge this PR.

@IanButterworth
Copy link
Copy Markdown
Member

I guess it's actions/runner-images#10721 because they're macos-12

@DilumAluthge
Copy link
Copy Markdown
Member Author

I see. I will remove those two macos-12 jobs from the list of required status checks.

@DilumAluthge DilumAluthge merged commit 887a1b8 into master Dec 16, 2024
@DilumAluthge DilumAluthge deleted the dpa/readme branch December 16, 2024 22:47
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.

3 participants