EDCD / EDCD/EDMarketConnector

Document various internal plugin output as harmless.

Open
#594 11 comments 0 reactions 0 assignees View on GitHub
documentation Plugins
Dominant language
Python
Stars
1.3k
Forks
182
Avg merge
1m
Merged PRs (30d)
1

Description

i.e. EDSM doesn't accept Ring data via its API. We don't want to *stop* sending such in case EDSM starts wanting it. So we need to document that:

- [x] `EDSM 402 Item unknown {"Periapsis": 0.0,"_systemCoordinates": [-33300.0,19.5625,3139.5],"BodyName": "Byeia Thoea JI-K c8-0 4 A Ring","...`

is harmless.

There'll possibly be other examples of this, including for the Inara API.

Contributor guide

Open the contributing guide

Research direction

No file, test, or entry point is named. Review the checked EDSM 402 Ring-data example and locate the project's existing documentation for plugin or API output, then check for comparable Inara examples. The issue is done when harmless responses are documented without disabling the existing sends.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.