Skip to content
This repository has been archived by the owner on Dec 15, 2022. It is now read-only.

GrammarRegistry docs link to wrong location #736

Open
1 task done
icecream17 opened this issue Sep 18, 2021 · 0 comments
Open
1 task done

GrammarRegistry docs link to wrong location #736

icecream17 opened this issue Sep 18, 2021 · 0 comments

Comments

@icecream17
Copy link

icecream17 commented Sep 18, 2021

Prerequisites

Description

https://flight-manual.atom.io/api/v1.57.0/GrammarRegistry/ links to the wrong location.

Should be [email protected]/src/grammar-registry.js

But got [email protected]/src/grammar-registry.coffee

Steps to Reproduce

  1. Go to https://flight-manual.atom.io/api/v1.57.0/GrammarRegistry/

Reproduces how often:

100%

Additional Information

Discovered by inconsistent types at https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/atom/src/grammar-registry.d.ts which are difference than the actual methods.

It seems that FirstMate's grammar registry is used for GrammarRegistry#textmateRegistry https://github.com/atom/atom/search?q=FirstMate

The methods are similar but not exactly the same. For example, GrammarRegistry doesn't have onDidRemoveGrammar

@icecream17 icecream17 changed the title GrammarRegistry docs are very outdated GrammarRegistry docs link to wrong location Sep 18, 2021
icecream17 added a commit to icecream17/DefinitelyTyped that referenced this issue Oct 7, 2021
add icecream17 as author, bump typescript version, grammar

Initial commit; just for creating a pr.
Note that even though there are docs online, they might be misleading: atom/flight-manual.atom.io#736
So I'll use the codebase itself: https://github.com/atom/atom/tree/v1.58.0
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant