derhuerst/hafas-find-stations

document how to use it with throttling

Open

#2 opened on Oct 17, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (1 fork)github user discovery
documentationhelp wanted

Repository metrics

Stars
 (3 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

When running hafas-find-stations with large bounding boxes, people will most likely get blocked by the respective HAFAS endpoint. We should documented how to use hafas-client/throttle in combination with hafas-find-stations.

Contributor guide

Research direction
Read the linked throttling docs and the hafas find stations README to understand how to integrate throttling into the example usage.
Tech stack
javascript
Domain
apidocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85