Skip to content

RFC: Syntax for embedding cargo-script manifests #3503

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.

Sign up for GitHub

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

Merged
joshtriplett merged 60 commits into from
Apr 23, 2024
Merged

RFC: Syntax for embedding cargo-script manifests #3503

Changes from 1 commit
Commits
Show all changes
60 commits
Select commit Hold shift + click to select a range
ddcaeea
feat: Add skeleton
epage Sep 26, 2023
290cb97
feat: Initial frontmatter RFC
epage Sep 26, 2023
c088429
fix: Update cross-links to cargo-script
epage Sep 26, 2023
f644b5f
fix: Update for RFC number
epage Sep 26, 2023
29839ae
fix: Grammar
epage Sep 26, 2023
d97eb11
fix: Add multi-frontmatter future possibility
epage Sep 26, 2023
f7b3f47
styke: Formatting
epage Sep 26, 2023
ea5d05e
fix: Correct PEP 723 description
epage Sep 26, 2023
8f144ee
fix: Remove some template boilerplate
epage Sep 26, 2023
a223b95
fix: Note that cargo being the default infostring for future
epage Sep 27, 2023
1a243fd
fix: Add more prior art
epage Sep 27, 2023
ddcca01
fix: Call out why shebang-ext needs backticks
epage Sep 27, 2023
67114fe
fix: Expand on a benefit
epage Sep 27, 2023
bcd9c6d
fix: Adjust formatting
epage Sep 27, 2023
bb26c75
fix: Remove redundant word
epage Sep 27, 2023
394387b
fix: Clarify cargo-script inside markdown
epage Sep 27, 2023
842f722
fix: Clarify why infostring default is deferred
epage Sep 27, 2023
42077b7
fix: Highlight meta macro idea
epage Sep 27, 2023
f955838
fix: Be clear on code fence vs fenced code block
epage Sep 27, 2023
0e671bf
fix: Update based on commonmark spec
epage Sep 27, 2023
1e4f518
fix: Address typo
epage Sep 27, 2023
97c6658
fix: Add heredoc benefits
epage Sep 27, 2023
8ac0bc4
fix: Add qualifier to alt build systems
epage Sep 27, 2023
48c385c
fix: Duplicate out downsides
epage Sep 27, 2023
421194a
fix: Tie this back to rustdoc as precedence
epage Sep 28, 2023
346b301
fix: Be more explicit
epage Sep 29, 2023
c237ad8
fix: Clarify some rationale for code fences
epage Sep 29, 2023
a21b55e
fix: Clarify downside for yaml presentation streams
epage Sep 29, 2023
97ca09a
fix: Clarify the unlikeliness of multiple formats
epage Sep 29, 2023
60d05ac
fix: Typos
epage Sep 29, 2023
38cf0ee
fix: Bring up newlines
epage Oct 3, 2023
c362514
fix: Ensure a syntax drawback is also in the comparison
epage Oct 3, 2023
e070754
fix: Add the cost of familiar syntax
epage Oct 3, 2023
5479104
fix: Call out parallels for rustc/cargo integration
epage Oct 3, 2023
7bcaca9
fix: Cover distinction from this and comments
epage Oct 4, 2023
e431c22
fix: Highlight edit/copy/paste impact of different options
epage Oct 5, 2023
a2d78cb
fix: Talk more to design goal difference with markdown
epage Oct 8, 2023
791f965
fix: Expand on why we delayed some decisions
epage Oct 8, 2023
7a687c2
fix: Re-order alternatives with assumed reasonableness of them
epage Oct 8, 2023
d179824
fix: Add a possible markdown workaround
epage Oct 8, 2023
1bbeb65
fix: Clarify the relationship between code fence / YAML frontmatter
epage Oct 8, 2023
0b56c98
refactor: Pull out link to 3502
epage Oct 16, 2023
6d8782c
fix: Include design principle from 3502
epage Oct 16, 2023
d2fc291
fix: Better highlight infostring handling
epage Dec 6, 2023
de9862a
fix: Cover required vs optional shebang
epage Dec 6, 2023
9f2aec2
fix: Expand on alternative syntax
epage Dec 6, 2023
1b860d4
feat: Make sure people know what they are signing up for
epage Dec 12, 2023
cdae2a7
fix: Grammar adjustments
epage Dec 12, 2023
05c44cc
fix: Note Bazel's import macro
epage Dec 14, 2023
2955406
fix(alt): Note problems with syntax that looks like merge conflicts
epage Jan 15, 2024
eab2309
Switch frontmatter syntax
epage Feb 1, 2024
82352ed
fix: Cover include macro
epage Feb 2, 2024
40228b8
fix: Talk about infostring stabilization
epage Feb 2, 2024
f9be5d4
fix(future): Use latest syntax
epage Feb 7, 2024
2e68244
fix(future): Loosen infostring requirements
epage Feb 7, 2024
f037dd0
fix(future): Call out different infostring attribute syntax
epage Feb 7, 2024
6d8bf53
fix(ref): Bad edit
epage Feb 7, 2024
ce78d92
fix(alt): Revamp prefix section
epage Feb 9, 2024
717bacd
fix: Typo
epage Feb 9, 2024
837efd1
feat(rationale): Step through why this needs to be in rustc
epage Feb 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix: Clarify why infostring default is deferred
  • Loading branch information
@epage
epage committed Sep 27, 2023
commit 842f722866e685f9281c30c516f965cf5136b696
1 change: 1 addition & 0 deletions text/3503-frontmatter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -453,6 +453,7 @@ pprint([(k, v["title"]) for k, v in data.items()][:10])
[future-possibilities]: #future-possibilities

- Treat `cargo` as the default infostring
Copy link

@pksunkara pksunkara Sep 27, 2023

Choose a reason for hiding this comment

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

What is the main reason for not including this in this proposal?

Copy link
Contributor Author

@epage epage Sep 27, 2023

Choose a reason for hiding this comment

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

I clarified this a little in 842f722

Copy link
Contributor Author

@epage epage Sep 27, 2023

Choose a reason for hiding this comment

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

Basically, we want to start with the absolute minimal approach and see what we feel needs to be relaxed from there (which is backwards compatible) rather than make a lot of assumptions and then regret them,

- Since this is a one-way door, we want to make sure we are confident that that is the right default / policy
- Support more infostring languages
- We need to better understand use cases for how this should be extended
- Support infostring attributes
Expand Down