killercup / killercup/test-rustdoc-example-scraping-across-workspace-on-docrs

Scraping examples: works locally but not on docs.rs

Open
#1 17 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

I tried to add scraped examples to bevy's API docs in https://github.com/bevyengine/bevy/pull/9154 but it [did not work on docs.rs](https://docs.rs/bevy/0.11.3/x86_64-pc-windows-msvc/bevy/input/struct.Input.html#method.just_pressed).

If you run `cargo +nightly doc -Zunstable-options -Zrustdoc-scrape-examples --open` locally and search for `just_pressed`, you'll see scraped examples.

This repo is about finding out what's happening.

Contributor guide

No contributing guide indexed for this repository

Research direction

Run `cargo +nightly doc -Zunstable-options -Zrustdoc-scrape-examples --open` and search for `just_pressed` to reproduce the local result. Compare it with the linked docs.rs API page and review the example-scraping attempt in PR #9154. Done means identifying why the scraped examples differ on docs.rs and documenting a reproducible explanation.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.