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.

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

Jump to bottom

Lots of small fixes to docs in the turbo-tasks crate #8651

Merged
merged 2 commits into from
Jul 3, 2024
Merged

Lots of small fixes to docs in the turbo-tasks crate #8651

merged 2 commits into from
Jul 3, 2024

Conversation

bgw
Copy link
Member

@bgw bgw commented Jul 2, 2024 •
edited
Loading

Description

Docs live here: https://turbopack-rust-docs.vercel.sh/rustdoc/turbo_tasks/index.html

  • Fixed lots of links.

  • Export VcCast, VcValueTypeCast, and VcValueTraitCast, as they're used in some type signatures, and some documentation is impossible to follow without it. This introduces the sealed trait pattern to VcCast to continue to strongly prevent foreign implementations.

Testing Instructions

cargo doc --keep-going -p turbo-tasks
cargo doc --keep-going --document-private-items -p turbo-tasks

@bgw
Lots of small fixes to docs in the turbo-tasks crate
49435c2 
- Fixed lots of links.

- Export `VcCast`, `VcValueTypeCast`, and `VcValueTraitCast`, as they're
  used in some type signatures, and some documentation is impossible to
  follow without it. This introduces the sealed trait pattern to
  `VcCast` to continue to strongly prevent foreign implementations.
@vercel Vercel
Copy link

vercel bot commented Jul 2, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
rust-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 2, 2024 9:26pm
9 Skipped Deployments
Name Status Preview Comments Updated (UTC)
examples-basic-web ⬜️ Ignored (Inspect) Visit Preview Jul 2, 2024 9:26pm
examples-designsystem-docs ⬜️ Ignored (Inspect) Visit Preview Jul 2, 2024 9:26pm
examples-gatsby-web ⬜️ Ignored (Inspect) Visit Preview Jul 2, 2024 9:26pm
examples-kitchensink-blog ⬜️ Ignored (Inspect) Visit Preview Jul 2, 2024 9:26pm
examples-native-web ⬜️ Ignored (Inspect) Visit Preview Jul 2, 2024 9:26pm
examples-svelte-web ⬜️ Ignored (Inspect) Visit Preview Jul 2, 2024 9:26pm
examples-tailwind-web ⬜️ Ignored (Inspect) Visit Preview Jul 2, 2024 9:26pm
examples-vite-web ⬜️ Ignored (Inspect) Visit Preview Jul 2, 2024 9:26pm
examples-nonmonorepo ⬜️ Skipped (Inspect) Jul 2, 2024 9:26pm

@bgw Graphite App
Copy link
Member Author

bgw commented Jul 2, 2024 •
edited
Loading

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @bgw and the rest of your teammates on Graphite Graphite

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 2, 2024 •
edited
Loading

⚠️ This change may fail to build next-swc.

Logs 

error: failed to select a version for `triomphe`.
    ... required by package `hstr v0.2.8`
    ... which satisfies dependency `hstr = "^0.2.8"` (locked to 0.2.8) of package `swc_atoms v0.6.7`
    ... which satisfies dependency `swc_atoms = "^0.6.5"` (locked to 0.6.7) of package `swc_core v0.95.4`
    ... which satisfies dependency `swc_core = "^0.95.4"` (locked to 0.95.4) of package `wasm v0.0.0 (/root/actions-runner/_work/turbo/turbo/packages/next-swc/crates/wasm)`
versions that meet the requirements `^0.1.11` (locked to 0.1.11) are: 0.1.11

all possible versions conflict with previously selected packages.

  previously selected package `triomphe v0.1.13`
    ... which satisfies dependency `triomphe = "^0.1.13"` of package `turbo-tasks v0.1.0 (https://github.com/vercel/turbo?rev=a0deb4284a406e4483f87f62d14c749ea15017ed#99d5435d)`
    ... which satisfies git dependency `turbo-tasks` (locked to 0.1.0) of package `next-build-test v0.1.0 (/root/actions-runner/_work/turbo/turbo/packages/next-swc/crates/next-build-test)`

failed to select a version for `triomphe` which could resolve this conflict

See job summary for details

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 2, 2024 •
edited
Loading

🟢 Turbopack Benchmark CI successful 🟢

Thanks

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 2, 2024 •
edited
Loading

⚠️ CI failed ⚠️

The following steps have failed in CI:

  • Turbopack Rust tests (mac/win, non-blocking)

See workflow summary for details

@vercel vercel bot temporarily deployed to Preview – examples-nonmonorepo July 2, 2024 21:24 Inactive
@bgw bgw marked this pull request as ready for review July 2, 2024 21:24
@bgw bgw requested a review from a team as a code owner July 2, 2024 21:24
@bgw bgw mentioned this pull request Jul 2, 2024
Merged
@bgw bgw merged commit 63c46a3 into main Jul 3, 2024
55 of 58 checks passed
@bgw bgw deleted the bgw/turbo-tasks-docs branch July 3, 2024 03:00
ForsakenHarmony pushed a commit to vercel/next.js that referenced this pull request Jul 25, 2024
@bgw
Lots of small fixes to docs in the turbo-tasks crate (vercel/turborep…
86ca239 
…o#8651)

### Description

Docs live here:
https://turbopack-rust-docs.vercel.sh/rustdoc/turbo_tasks/index.html

- Fixed lots of links.

- Export `VcCast`, `VcValueTypeCast`, and `VcValueTraitCast`, as they're
used in some type signatures, and some documentation is impossible to
follow without it. This introduces the sealed trait pattern to `VcCast`
to continue to strongly prevent foreign implementations.


### Testing Instructions

```
cargo doc --keep-going -p turbo-tasks
cargo doc --keep-going --document-private-items -p turbo-tasks
```
ForsakenHarmony pushed a commit to vercel/next.js that referenced this pull request Jul 29, 2024
@bgw
Lots of small fixes to docs in the turbo-tasks crate (vercel/turborep…
ea5d77f 
…o#8651)

### Description

Docs live here:
https://turbopack-rust-docs.vercel.sh/rustdoc/turbo_tasks/index.html

- Fixed lots of links.

- Export `VcCast`, `VcValueTypeCast`, and `VcValueTraitCast`, as they're
used in some type signatures, and some documentation is impossible to
follow without it. This introduces the sealed trait pattern to `VcCast`
to continue to strongly prevent foreign implementations.


### Testing Instructions

```
cargo doc --keep-going -p turbo-tasks
cargo doc --keep-going --document-private-items -p turbo-tasks
```
ForsakenHarmony pushed a commit to vercel/next.js that referenced this pull request Jul 29, 2024
@bgw
Lots of small fixes to docs in the turbo-tasks crate (vercel/turborep…
30a18d5 
…o#8651)

### Description

Docs live here:
https://turbopack-rust-docs.vercel.sh/rustdoc/turbo_tasks/index.html

- Fixed lots of links.

- Export `VcCast`, `VcValueTypeCast`, and `VcValueTraitCast`, as they're
used in some type signatures, and some documentation is impossible to
follow without it. This introduces the sealed trait pattern to `VcCast`
to continue to strongly prevent foreign implementations.


### Testing Instructions

```
cargo doc --keep-going -p turbo-tasks
cargo doc --keep-going --document-private-items -p turbo-tasks
```
ForsakenHarmony pushed a commit to vercel/next.js that referenced this pull request Aug 1, 2024
@bgw
Lots of small fixes to docs in the turbo-tasks crate (vercel/turborep…
091a8e1 
…o#8651)

### Description

Docs live here:
https://turbopack-rust-docs.vercel.sh/rustdoc/turbo_tasks/index.html

- Fixed lots of links.

- Export `VcCast`, `VcValueTypeCast`, and `VcValueTraitCast`, as they're
used in some type signatures, and some documentation is impossible to
follow without it. This introduces the sealed trait pattern to `VcCast`
to continue to strongly prevent foreign implementations.


### Testing Instructions

```
cargo doc --keep-going -p turbo-tasks
cargo doc --keep-going --document-private-items -p turbo-tasks
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kdy1 kdy1 kdy1 approved these changes

@ForsakenHarmony ForsakenHarmony Awaiting requested review from ForsakenHarmony

@LichuAcu LichuAcu Awaiting requested review from LichuAcu

@wbinnssmith wbinnssmith Awaiting requested review from wbinnssmith

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@bgw @kdy1