emscripten-core/emscripten

Documentation - API Reference - Fetch API - Synchronous Fetches seems out of date

Open

#15,016 opened on Sep 9, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C++ (27,361 stars) (3,519 forks)batch import
docsgood first bughelp wanted

Description

https://github.com/emscripten-core/emscripten/blob/main/site/source/docs/api_reference/fetch.rst#synchronous-fetches

It states: --proxy-to-worker + -s USE_PTHREADS=1: Synchronous Fetch operations are available both on the main thread and pthreads.

If you try to apply those flags with 2.0.26 you get: --proxy-to-worker is not supported with -s USE_PTHREADS>0! Use the option -s PROXY_TO_PTHREAD=1 if you want to run the main thread of a multithreaded application in a web worker.

Contributor guide

Tech stack
cppjavascriptwasm
Domain
apidocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
EmscriptenreStructuredText
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Locate the file 'site/source/docs/api reference/fetch.rst' and find the section 'Synchronous Fetches'. Update the description to match the actual behavior: ' proxy to worker is not supported with s USE PTHREADS>0' and recommend using s PROXY TO PTHREAD=1 instead. Check for any other references to proxy to worker in the same file to ensure consistency.
Documentation - API Reference - Fetch API - Synchronous Fetches seems out of date · emscripten-core/emscripten#15016 | Good First Issue