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

fix(init): don't gitignore triple-dash #1289

Merged
merged 1 commit into from
Apr 26, 2024

Conversation

chadoh
Copy link
Contributor

@chadoh chadoh commented Apr 25, 2024

The --- is only for the README.md file, not gitignore.

I've also switched the "(ab)used link label (for use with reference
style links)"-style comment ([//] #) for an HTML comment (<!-- ... -->). This means it will be rendered in the HTML, which might be
preferable, and is at a minimum benign. I hadn't been familiar with the
[//]: #-style comment until I saw it here (and searched to find a
description of it, along with the "(ab)use" line above, here), and I
don't think it's worth the potential confusion for users of soroban contract init.

Copy link
Contributor

@elizabethengelman elizabethengelman left a comment

Choose a reason for hiding this comment

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

Looks good to me! 👏

cmd/soroban-cli/src/commands/contract/init.rs Show resolved Hide resolved
@willemneal willemneal enabled auto-merge (squash) April 25, 2024 15:07
@chadoh chadoh force-pushed the fix/init/gitignore-delimiter branch from 7e841a8 to ff23a0d Compare April 25, 2024 18:42
The `---` is only for the `README.md` file, not `gitignore`.

I've also switched the "(ab)used link label (for use with reference
style links)"-style comment (`[//] #`) for an HTML comment (`<!-- ...
-->`). This means it will be rendered in the HTML, which might be
preferable, and is at a minimum benign. I hadn't been familiar with the
`[//]: #`-style comment until I saw it here (and searched to find a
description of it, along with the "(ab)use" line above, [here]), and I
don't think it's worth the potential confusion for users of `soroban
contract init`.

  [here]: https://stackoverflow.com/a/20885980/249801
@chadoh chadoh force-pushed the fix/init/gitignore-delimiter branch from ff23a0d to 2002fa4 Compare April 25, 2024 18:57
@willemneal willemneal merged commit 3c7410c into stellar:main Apr 26, 2024
17 checks passed
@chadoh chadoh deleted the fix/init/gitignore-delimiter branch April 26, 2024 20:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants