sharvil / api-docs Goto Github PK

View Code? Open in Web Editor NEW

57.0 57.0 9.0 180 KB

An API documentation browser for Atom.

License: Other

JavaScript 98.71% CSS 1.29%

api-docs's People

Contributors

Stargazers

Watchers

Forkers

thalesmello madcapjake knownasilya amon-ra ulidtko eboracus staberinde laiyongqin tatish777

api-docs's Issues

Add dark theme

Your package is really useful! It makes searches on devdocs much faster.
The menu is also beautiful but the result page should have a dark theme, for example, the one of devdocs, or even better, it could adapt itself to the current user UI theme.

Uncaught Error: The workspace can only contain one instance of item [object Object]

Hi there this is my first issue creation for atom so I guess it might be a bit less informative.
The plugin is good but have some bad sides as not opening new column only for documentation.

open a document and browse documentation in second column
open third column and try to browse the documentation again

Atom Version: 1.0.11
System: Microsoft Windows Server 2008 R2 Enterprise
Thrown From: api-docs package, v0.0.3

Stack Trace

Uncaught Error: The workspace can only contain one instance of item [object Object]

At C:\Users\Kiril\AppData\Local\atom\app-1.0.11\resources\app.asar\src\item-registry.js:11

Error: The workspace can only contain one instance of item [object Object]
  at ItemRegistry.module.exports.ItemRegistry.addItem (C:\Users\Kiril\AppData\Local\atom\app-1.0.11\resources\app.asar\src\item-registry.js:11:15)
  at PaneContainer.module.exports.PaneContainer.addedPaneItem (C:\Users\Kiril\AppData\Local\atom\app-1.0.11\resources\app.asar\src\pane-container.js:351:25)
  at C:\Users\Kiril\AppData\Local\atom\app-1.0.11\resources\app.asar\src\pane-container.js:339:26
  at Emitter.module.exports.Emitter.emit (C:\Users\Kiril\AppData\Local\atom\app-1.0.11\resources\app.asar\node_modules\event-kit\lib\emitter.js:82:11)
  at Pane.module.exports.Pane.addItem (C:\Users\Kiril\AppData\Local\atom\app-1.0.11\resources\app.asar\src\pane.js:345:20)
  at Pane.module.exports.Pane.activateItem (C:\Users\Kiril\AppData\Local\atom\app-1.0.11\resources\app.asar\src\pane.js:313:14)
  at DocView.attached (C:\Users\Kiril\.atom\packages\api-docs\src\doc_view.js:115:18)
  at space-pen-div.View.element.attached (C:\Users\Kiril\AppData\Local\atom\app-1.0.11\resources\app.asar\node_modules\atom-space-pen-views\node_modules\space-pen\lib\space-pen.js:164:63)
  at space-pen-div.CustomElementPrototype.attachedCallback (C:\Users\Kiril\AppData\Local\atom\app-1.0.11\resources\app.asar\node_modules\atom-space-pen-views\node_modules\space-pen\lib\space-pen.js:51:55)
  at atom-pane.PaneElement.activeItemChanged (C:\Users\Kiril\AppData\Local\atom\app-1.0.11\resources\app.asar\src\pane-element.js:150:24)
  at Emitter.module.exports.Emitter.emit (C:\Users\Kiril\AppData\Local\atom\app-1.0.11\resources\app.asar\node_modules\event-kit\lib\emitter.js:82:11)
  at Pane.module.exports.Pane.setActiveItem (C:\Users\Kiril\AppData\Local\atom\app-1.0.11\resources\app.asar\src\pane.js:250:22)
  at Pane.module.exports.Pane.activateItem (C:\Users\Kiril\AppData\Local\atom\app-1.0.11\resources\app.asar\src\pane.js:314:21)
  at C:\Users\Kiril\AppData\Local\atom\app-1.0.11\resources\app.asar\src\workspace.js:489:16
  at _fulfilled (C:\Users\Kiril\AppData\Local\atom\app-1.0.11\resources\app.asar\node_modules\q\q.js:794:54)
  at self.promiseDispatch.done (C:\Users\Kiril\AppData\Local\atom\app-1.0.11\resources\app.asar\node_modules\q\q.js:823:30)
  at Promise.promise.promiseDispatch (C:\Users\Kiril\AppData\Local\atom\app-1.0.11\resources\app.asar\node_modules\q\q.js:756:13)
  at C:\Users\Kiril\AppData\Local\atom\app-1.0.11\resources\app.asar\node_modules\q\q.js:817:14
  at flush (C:\Users\Kiril\AppData\Local\atom\app-1.0.11\resources\app.asar\node_modules\q\q.js:110:17)
  at process._tickCallback (node.js:357:13)

Commands

     -0:56.6.0 autocomplete-plus:confirm (atom-text-editor.editor.is-focused.autocomplete-active)
     -0:55.8.0 api-docs:search-under-cursor (atom-text-editor.editor.is-focused)
     -0:54.9.0 core:confirm (atom-text-editor.editor.mini.is-focused)
     -0:47.2.0 pane:split-right (div.api-docs-doc.api-docs-theme-light)
     -0:44.2.0 core:save (atom-text-editor.editor.is-focused)
     -0:43.4.0 core:copy (atom-text-editor.editor.is-focused)
     -0:38.2.0 fuzzy-finder:toggle-file-finder (atom-pane.pane.active)
     -0:35 core:confirm (atom-text-editor.editor.mini.is-focused)
     -0:31.1.0 command-palette:toggle (atom-text-editor.editor.is-focused)
     -0:29.9.0 editor:consolidate-selections (atom-text-editor.editor.mini.is-focused)
     -0:29.9.0 core:cancel (atom-text-editor.editor.mini.is-focused)
     -0:26.8.0 command-palette:toggle (atom-text-editor.editor.is-focused)
     -0:24.5.0 editor:consolidate-selections (atom-text-editor.editor.mini.is-focused)
     -0:24.5.0 core:cancel (atom-text-editor.editor.mini.is-focused)
     -0:23.5.0 api-docs:search-under-cursor (atom-text-editor.editor.is-focused)
     -0:22.6.0 core:confirm (atom-text-editor.editor.mini.is-focused)

Config

{
  "core": {
    "themes": [
      "atom-light-ui",
      "solarized-dark-syntax"
    ],
    "disabledPackages": [
      "open-on-github"
    ]
  },
  "api-docs": {
    "jquery": true,
    "php": true
  }
}

Installed Packages

# User
api-docs, v0.0.3
highlight-selected, v0.10.1
Remote-FTP, v0.7.2

# Dev
No dev packages

Option to add different apidocs to config

To add rust I had to modify library.js and add 'rust'

Perhaps scraping the current file extension/type would yield only relevant results?

Uncaught TypeError: Cannot read property 'length' of undefined

I have this error when call apidoc by press ctrl+i (i have change this because of ctrld non worked) in a window. the help works but these error window give problem of editing
please

[Enter steps to reproduce below:]

Atom Version: 1.12.5
Electron Version: 1.3.9
System: Unknown Windows Version
Thrown From: api-docs package, v0.0.6

Stack Trace

Uncaught TypeError: Cannot read property 'length' of undefined

At C:\Users\provs\.atom\packages\api-docs\src\query_view.js:69

TypeError: Cannot read property 'length' of undefined
    at QueryView.getIcon_ (file:///C:/Users/provs/.atom/packages/api-docs/src/query_view.js:69:24)
    at QueryView.viewForItem (file:///C:/Users/provs/.atom/packages/api-docs/src/query_view.js:26:17)
    at QueryView.module.exports.SelectListView.populateList (C:\Users\provs\.atom\packages\api-docs\node_modules\atom-space-pen-views\lib\select-list-view.js:206:29)
    at QueryView.module.exports.SelectListView.setItems (C:\Users\provs\.atom\packages\api-docs\node_modules\atom-space-pen-views\lib\select-list-view.js:167:12)
    at new QueryView (file:///C:/Users/provs/.atom/packages/api-docs/src/query_view.js:20:10)
    at Application.searchUnderCursor_ (file:///C:/Users/provs/.atom/packages/api-docs/src/main.js:45:5)
    at CommandRegistry.module.exports.CommandRegistry.handleCommandEvent (C:\Users\provs\AppData\Local\atom\app-1.12.5\resources\app.asar\src\command-registry.js:259:29)
    at C:\Users\provs\AppData\Local\atom\app-1.12.5\resources\app.asar\src\command-registry.js:3:59
    at CommandPaletteView.module.exports.CommandPaletteView.confirmed (C:\Users\provs\AppData\Local\atom\app-1.12.5\resources\app.asar\node_modules\command-palette\lib\command-palette-view.js:210:32)
    at CommandPaletteView.module.exports.SelectListView.confirmSelection (C:\Users\provs\AppData\Local\atom\app-1.12.5\resources\app.asar\node_modules\atom-space-pen-views\lib\select-list-view.js:338:21)
    at space-pen-div.atom.commands.add.core:confirm (C:\Users\provs\AppData\Local\atom\app-1.12.5\resources\app.asar\node_modules\atom-space-pen-views\lib\select-list-view.js:109:19)
    at CommandRegistry.module.exports.CommandRegistry.handleCommandEvent (C:\Users\provs\AppData\Local\atom\app-1.12.5\resources\app.asar\src\command-registry.js:259:29)
    at C:\Users\provs\AppData\Local\atom\app-1.12.5\resources\app.asar\src\command-registry.js:3:59
    at KeymapManager.module.exports.KeymapManager.dispatchCommandEvent (C:\Users\provs\AppData\Local\atom\app-1.12.5\resources\app.asar\node_modules\atom-keymap\lib\keymap-manager.js:587:16)
    at KeymapManager.module.exports.KeymapManager.handleKeyboardEvent (C:\Users\provs\AppData\Local\atom\app-1.12.5\resources\app.asar\node_modules\atom-keymap\lib\keymap-manager.js:382:22)
    at WindowEventHandler.module.exports.WindowEventHandler.handleDocumentKeyEvent (C:\Users\provs\AppData\Local\atom\app-1.12.5\resources\app.asar\src\window-event-handler.js:106:36)
    at HTMLDocument.<anonymous> (C:\Users\provs\AppData\Local\atom\app-1.12.5\resources\app.asar\src\window-event-handler.js:3:59)

Commands

 15x -3:05.9.0 find-and-replace:select-next (atom-text-editor.editor.is-focused)
     -0:17.9.0 command-palette:toggle (atom-text-editor.editor.is-focused)
     -0:15.8.0 core:move-down (atom-text-editor.editor.mini.is-focused)
     -0:13.4.0 core:confirm (atom-text-editor.editor.mini.is-focused)
     -0:13.4.0 api-docs:search-under-cursor (atom-text-editor.editor)

Config

{
  "core": {
    "telemetryConsent": "no"
  },
  "api-docs": {
    "cpp": true
  }
}

Installed Packages

# User
api-docs, v0.0.6 (active)
atom-dark-syntax, v0.27.0 (inactive)
atom-dark-ui, v0.52.0 (inactive)
atom-light-syntax, v0.28.0 (inactive)
atom-light-ui, v0.45.0 (inactive)
base16-tomorrow-dark-theme, v1.3.0 (inactive)
base16-tomorrow-light-theme, v1.3.0 (inactive)
one-dark-ui, v1.6.2 (active)
one-light-ui, v1.6.2 (inactive)
one-dark-syntax, v1.5.0 (active)
one-light-syntax, v1.5.0 (inactive)
solarized-dark-syntax, v1.0.5 (inactive)
solarized-light-syntax, v1.0.5 (inactive)
about, v1.7.0 (active)
archive-view, v0.62.0 (active)
autocomplete-atom-api, v0.10.0 (active)
autocomplete-css, v0.13.1 (active)
autocomplete-html, v0.7.2 (active)
autocomplete-plus, v2.31.4 (active)
autocomplete-snippets, v1.11.0 (active)
autoflow, v0.27.0 (inactive)
autosave, v0.23.1 (active)
background-tips, v0.26.1 (active)
bookmarks, v0.42.0 (active)
bracket-matcher, v0.82.2 (active)
command-palette, v0.39.0 (active)
deprecation-cop, v0.54.1 (active)
dev-live-reload, v0.47.0 (active)
encoding-selector, v0.22.0 (active)
exception-reporting, v0.40.0 (active)
find-and-replace, v0.202.2 (active)
fuzzy-finder, v1.4.0 (active)
git-diff, v1.1.0 (active)
go-to-line, v0.31.0 (inactive)
grammar-selector, v0.48.2 (active)
image-view, v0.60.0 (active)
incompatible-packages, v0.26.1 (active)
keybinding-resolver, v0.35.0 (active)
line-ending-selector, v0.5.0 (active)
link, v0.31.2 (inactive)
markdown-preview, v0.158.8 (active)
metrics, v1.1.2 (active)
notifications, v0.65.1 (active)
open-on-github, v1.2.1 (inactive)
package-generator, v1.0.1 (inactive)
settings-view, v0.243.1 (active)
snippets, v1.0.4 (active)
spell-check, v0.68.4 (active)
status-bar, v1.4.1 (active)
styleguide, v0.47.2 (active)
symbols-view, v0.113.1 (inactive)
tabs, v0.103.0 (active)
timecop, v0.33.2 (active)
tree-view, v0.210.0 (active)
update-package-dependencies, v0.10.0 (active)
welcome, v0.35.1 (active)
whitespace, v0.35.0 (active)
wrap-guide, v0.38.2 (active)
language-c, v0.54.0 (active)
language-clojure, v0.22.1 (active)
language-coffee-script, v0.48.0 (active)
language-csharp, v0.13.0 (active)
language-css, v0.40.1 (active)
language-gfm, v0.88.0 (active)
language-git, v0.15.0 (active)
language-go, v0.43.0 (active)
language-html, v0.47.1 (active)
language-hyperlink, v0.16.1 (active)
language-java, v0.24.0 (active)
language-javascript, v0.122.0 (active)
language-json, v0.18.3 (active)
language-less, v0.29.6 (active)
language-make, v0.22.2 (active)
language-mustache, v0.13.0 (active)
language-objective-c, v0.15.1 (active)
language-perl, v0.37.0 (active)
language-php, v0.37.3 (active)
language-property-list, v0.8.0 (active)
language-python, v0.45.1 (active)
language-ruby, v0.70.2 (active)
language-ruby-on-rails, v0.25.1 (active)
language-sass, v0.57.0 (active)
language-shellscript, v0.23.0 (active)
language-source, v0.9.0 (active)
language-sql, v0.25.0 (active)
language-text, v0.7.1 (active)
language-todo, v0.29.1 (active)
language-toml, v0.18.1 (active)
language-xml, v0.34.12 (active)
language-yaml, v0.27.1 (active)

# Dev
No dev packages

python was not found

Python was not found; run without arguments to install from the Microsoft Store, or disable this shortcut from Settings > Manage App Execution Aliases.
[Finished in 0.576s]

Adding additional doc sources

Would it be possible to add additional sources? For example, I was attempting to use scikit-learn docs, which are hosted on Devdocs here.

Uncaught TypeError: Cannot read property 'getGrammar' of undefined

Steps to reproduce

Trigger the Search Under Cursor command from the Settings pane.

Atom Version: 1.0.0
System: Mac OS X 10.10.3
Thrown From: api-docs package, v0.0.1

Stack Trace

Uncaught TypeError: Cannot read property 'getGrammar' of undefined

At /Users/mert/.atom/packages/api-docs/src/main.js:41

TypeError: Cannot read property 'getGrammar' of undefined
  at Application.searchUnderCursor_ (/Users/mert/.atom/packages/api-docs/src/main.js:41:27)
  at CommandRegistry.module.exports.CommandRegistry.handleCommandEvent (/Applications/Atom.app/Contents/Resources/app.asar/src/command-registry.js:241:29)
  at /Applications/Atom.app/Contents/Resources/app.asar/src/command-registry.js:3:61
  at CommandPaletteView.module.exports.CommandPaletteView.confirmed (/Applications/Atom.app/Contents/Resources/app.asar/node_modules/command-palette/lib/command-palette-view.js:159:32)
  at CommandPaletteView.module.exports.SelectListView.confirmSelection (/Applications/Atom.app/Contents/Resources/app.asar/node_modules/atom-space-pen-views/lib/select-list-view.js:338:21)
  at space-pen-div.atom.commands.add.core:confirm (/Applications/Atom.app/Contents/Resources/app.asar/node_modules/atom-space-pen-views/lib/select-list-view.js:109:19)
  at CommandRegistry.module.exports.CommandRegistry.handleCommandEvent (/Applications/Atom.app/Contents/Resources/app.asar/src/command-registry.js:241:29)
  at /Applications/Atom.app/Contents/Resources/app.asar/src/command-registry.js:3:61
  at KeymapManager.module.exports.KeymapManager.dispatchCommandEvent (/Applications/Atom.app/Contents/Resources/app.asar/node_modules/atom-keymap/lib/keymap-manager.js:520:16)
  at KeymapManager.module.exports.KeymapManager.handleKeyboardEvent (/Applications/Atom.app/Contents/Resources/app.asar/node_modules/atom-keymap/lib/keymap-manager.js:355:22)
  at HTMLDocument.module.exports.WindowEventHandler.onKeydown (/Applications/Atom.app/Contents/Resources/app.asar/src/window-event-handler.js:180:20)

Commands

     -0:08.4.0 command-palette:toggle (div.settings-view.pane-item)
     -0:03.6.0 core:backspace (atom-text-editor.editor.mini.is-focused)
     -0:00.7.0 core:confirm (atom-text-editor.editor.mini.is-focused)
     -0:00.6.0 api-docs:search-under-cursor (div.settings-view.pane-item)

Config

{
  "core": {},
  "api-docs": {
    "node": true,
    "git": true,
    "coffeescript": true,
    "npm": true,
    "ruby": true,
    "rails": true,
    "svg": true
  }
}

Installed Packages

# User
api-docs, v0.0.1
browser-refresh, v0.9.0
pigments, v0.8.1
svg-preview, v0.6.0

# Dev
No dev packages

White block in bottom corner of doc view when in dark mode

Super minor issue but there is a white block residing in the bottom right corner, that looks 'un-themed', when using dark mode. Seems like it may be the corner block between the vertical and horizontal scroll bars?

strg+d not working

Hey, your documentation browser fot atom looks pretty interesting 👍

Unfortunately when I press ctrl-d the only thing that happens is, that the word after the cursor gets selected but nothing more. I suspect, something is wrong with my key-bindings maybe?

Do you have a hint for me how I can get that fixed?

Uncaught Error: Pane has been destroyed

Closed api-docs tab

Atom Version: 0.207.0
System: Mac OS X 10.10.3
Thrown From: api-docs package, v0.0.1

Stack Trace

Uncaught Error: Pane has been destroyed

At /opt/homebrew-cask/Caskroom/atom/latest/Atom.app/Contents/Resources/app.asar/src/pane.js:604

Error: Pane has been destroyed
  at Pane.module.exports.Pane.activate (/opt/homebrew-cask/Caskroom/atom/latest/Atom.app/Contents/Resources/app.asar/src/pane.js:604:15)
  at Pane.module.exports.Pane.focus (/opt/homebrew-cask/Caskroom/atom/latest/Atom.app/Contents/Resources/app.asar/src/pane.js:193:21)
  at atom-pane.<anonymous> (/opt/homebrew-cask/Caskroom/atom/latest/Atom.app/Contents/Resources/app.asar/src/pane-element.js:59:23)
  at atom-pane.<anonymous> (/opt/homebrew-cask/Caskroom/atom/latest/Atom.app/Contents/Resources/app.asar/src/pane-element.js:61:18)
  at atom-pane.PaneElement.activated (/opt/homebrew-cask/Caskroom/atom/latest/Atom.app/Contents/Resources/app.asar/src/pane-element.js:125:19)
  at Emitter.module.exports.Emitter.emit (/opt/homebrew-cask/Caskroom/atom/latest/Atom.app/Contents/Resources/app.asar/node_modules/event-kit/lib/emitter.js:82:11)
  at Pane.module.exports.Pane.activate (/opt/homebrew-cask/Caskroom/atom/latest/Atom.app/Contents/Resources/app.asar/src/pane.js:612:27)
  at PaneContainer.module.exports.PaneContainer.activateNextPane (/opt/homebrew-cask/Caskroom/atom/latest/Atom.app/Contents/Resources/app.asar/src/pane-container.js:272:26)
  at Pane.module.exports.Pane.destroyed (/opt/homebrew-cask/Caskroom/atom/latest/Atom.app/Contents/Resources/app.asar/src/pane.js:627:24)
  at Pane.module.exports.Model.destroy (/opt/homebrew-cask/Caskroom/atom/latest/Atom.app/Contents/Resources/app.asar/src/model.js:45:58)
  at Pane.module.exports.Pane.destroy (/opt/homebrew-cask/Caskroom/atom/latest/Atom.app/Contents/Resources/app.asar/src/pane.js:620:39)
  at DocView.destroy (/Users/rpavlick/.atom/packages/api-docs/src/doc_view.js:75:18)
  at Pane.module.exports.Pane.destroyItem (/opt/homebrew-cask/Caskroom/atom/latest/Atom.app/Contents/Resources/app.asar/src/pane.js:444:18)
  at HTMLDivElement.<anonymous> (/opt/homebrew-cask/Caskroom/atom/latest/Atom.app/Contents/Resources/app.asar/node_modules/tabs/lib/tab-bar-view.js:195:22)
  at space-pen-ul.jQuery.event.dispatch (/opt/homebrew-cask/Caskroom/atom/latest/Atom.app/Contents/Resources/app.asar/node_modules/jquery/dist/jquery.js:4435:9)
  at space-pen-ul.elemData.handle (/opt/homebrew-cask/Caskroom/atom/latest/Atom.app/Contents/Resources/app.asar/node_modules/jquery/dist/jquery.js:4121:28)

Commands

  2x -8:41.9.0 core:backspace (atom-text-editor.editor.is-focused)
     -8:41.3.0 api-docs:search-under-cursor (atom-text-editor.editor.is-focused)
  2x -6:48.8.0 core:backspace (atom-text-editor.editor.mini.is-focused)
     -6:47.6.0 core:confirm (atom-text-editor.editor.mini.is-focused)
  4x -1:37 core:delete (ul.list-inline.tab-bar.inset-panel)
     -1:34.7.0 api-docs:search-under-cursor (atom-text-editor.editor.is-focused)
     -1:29.4.0 find-and-replace:show (div.api-docs-doc)
  5x -1:27.7.0 core:backspace (atom-text-editor.editor.mini.is-focused)
     -1:25.8.0 core:confirm (atom-text-editor.editor.mini.is-focused)
     -1:25 core:select-all (atom-text-editor.editor.mini.is-focused)
     -1:24.9.0 core:backspace (atom-text-editor.editor.mini.is-focused)
     -0:23.1.0 core:delete (ul.list-inline.tab-bar.inset-panel)
     -0:21.5.0 api-docs:search-under-cursor (atom-text-editor.editor.is-focused)

Config

{
  "core": {
    "themes": [
      "atom-light-ui",
      "atom-light-syntax"
    ]
  },
  "api-docs": {
    "css": false,
    "dom_events": false,
    "dom": false,
    "html": false,
    "http": false,
    "javascript": false,
    "python": true
  }
}

Installed Packages

# User
api-docs, vundefined
git-projects, v1.14.1
language-fortran, v1.5.6
language-idl, v0.2.0
language-julia, v0.9.0
language-matlab, v0.1.1
language-r, v0.2.0
linter, v0.12.6
linter-shellcheck, v0.0.8
linter-write-good, v0.4.3

# Dev
No dev packages

keeps loading for python2 and python3.5.

Hi!

This is really an outstanding plugin and I like it a lot so far! :)
However, I run into issues when trying to use Python2.7 och Python3.5.
When I try to search for a word the window openes, but just keeps loading and nothing more happens.

When I debug your code on line: 36 in doc_view.js, it seams like the path is a bit strange and is set to ex.: "3.5~/library/import". This might not be the problem, but if I do the same search for html which works, the path is set to: "element/a" which seams a bit cleaner with no path-prefix.

I really would love this to work also for Python!

Many thanks!

Closing the API Docs tab closes the entire pane

This was alluded to in #10, but when closing the API Docs tab, the entire pane is closed, including any other tabs that are currently open in the pane.

This is currently happening in Atom 1.0.11.

Failed to load the api-docs package

This is what I get as soon as I install the api-docs package and it attempts to load.

Atom Version: 0.188.0
System: linux 3.19.0-39-generic
Thrown From: api-docs package, v0.0.4

Stack Trace

Failed to load the api-docs package

At /home/micah/.atom/packages/api-docs/src/main.js: Unexpected token (12:29)
  10 | 
  11 | class Application {
> 12 |   static LAZY_LOAD_DELAY_MS_ = 3000;
     |                              ^
  13 | 
  14 |   constructor() {
  15 |     this.subscriptions_ = new CompositeDisposable();

SyntaxError: /home/micah/.atom/packages/api-docs/src/main.js: Unexpected token (12:29)
  10 | 
  11 | class Application {
> 12 |   static LAZY_LOAD_DELAY_MS_ = 3000;
     |                              ^
  13 | 
  14 |   constructor() {
  15 |     this.subscriptions_ = new CompositeDisposable();
    at raise (/usr/share/atom/resources/app/node_modules/babel-core/node_modules/acorn-babel/acorn_csp.js:343:15)
    at unexpected (/usr/share/atom/resources/app/node_modules/babel-core/node_modules/acorn-babel/acorn_csp.js:2278:5)
    at expect (/usr/share/atom/resources/app/node_modules/babel-core/node_modules/acorn-babel/acorn_csp.js:2266:18)
    at parseFunctionParams (/usr/share/atom/resources/app/node_modules/babel-core/node_modules/acorn-babel/acorn_csp.js:3571:5)
    at parseMethod (/usr/share/atom/resources/app/node_modules/babel-core/node_modules/acorn-babel/acorn_csp.js:3558:5)
    at parseClass (/usr/share/atom/resources/app/node_modules/babel-core/node_modules/acorn-babel/acorn_csp.js:3703:24)
    at parseStatement (/usr/share/atom/resources/app/node_modules/babel-core/node_modules/acorn-babel/acorn_csp.js:2603:14)
    at parseTopLevel (/usr/share/atom/resources/app/node_modules/babel-core/node_modules/acorn-babel/acorn_csp.js:2567:18)
    at Object.exports.parse (/usr/share/atom/resources/app/node_modules/babel-core/node_modules/acorn-babel/acorn_csp.js:51:12)
    at module.exports (/usr/share/atom/resources/app/node_modules/babel-core/lib/babel/helpers/parse.js:18:21)

Commands

     -0:49.9 settings-view:check-for-package-updates (atom-workspace.workspace.scrollbars-visible-always.theme-base16-tomorrow-dark-theme.theme-one-dark-ui)

Config

{
  "core": {
    "themes": [
      "one-dark-ui",
      "base16-tomorrow-dark-theme"
    ]
  }
}

Installed Packages

# User
api-docs, v0.0.4
autocomplete-glsl, v0.2.3
language-glsl, v2.0.1
language-liquid, v0.4.0
language-opencl, v0.1.1
language-purescript, v0.6.1
language-shadercode, v2.0.0
language-shadercode-shaderlab, v2.0.1

# Dev
No dev packages

I can not uninstall the plugin

Every time I click Uninstall it appears this error message:
Failed to delete api-docs: EPERM: operation not permitted, lstat 'C:\Users\httpiago\.atom\packages\api-docs\data\html.1515954380'

Can't search in result page

I installed api-docs 0.0.3 and enabled Python 2 in the settings. I used the command palette to search for re.search(). This opens a lengthy page. It would be nice if I could use Command-F to search in it, but that's not possible.

ctrl-d doesn't seem to work when searching for documentation

I just installed api-docs on my iMac but ctrl-d doesn't seem to work at all when searching for documentation. Could it be that the key binding is clashing with some other Atom package? I am new at this, and have the following packages installed: api-docs, atom-beautify, atom-typescript, autocomplete-paths, emmet, linter, linter-csslint, linter-eslint, linter-htmlhint. I don't expect you to spend any time reviewing any of these other packages but I was just wondering whether I am missing something obvious. I installed the above packages following the advice in Chapter 1 of a book I just purchased, entitled "Front-End Web Development" by Big Nerd Ranch.

REQUEST: Add source of documentation

When the selection under the cursor is ambiguous, it would be nice to list the origin of each possible entry. For example, if I click on the word "set" in the code

function foo() {
_.set(...);
}

I get the attached list, which is less than obvious. Even though the icons provide a hint, Adding something like:

lodash 4: set

would make it clearer.

No matches found

Regardless of language I always get No matches found

Atom: 1.44.0
api-docs: 0.0.6

Nothing happens when selecting doc entry in palette

Clicking or hitting enter on a doc entry will close the palette and do nothing. There don't appear to be any messages relating to this in the console.

Atom version: 1.13.0-beta6
api-docs version: 0.0.6

Running macOS Sierra

(Almost) Doesn't allow scrolling via keyboard

I installed api-docs 0.0.3 and I disabled the keybindings. I enabled Python 2 in the settings. I searched for re.search(). This opens a long page, but I almost can't scroll via the keyboard.

Space, page down, cursor down, j -- all do nothing.

I can hit Tab, which focuses the first link on the page ("RegexObject") and I can then use Space and Shift-Space to scroll by pages. But page down still does not work, and neither do the cursor keys for scrolling by line.

I think after opening the page in the browser, there should be some sane keys for scrolling. I very much like less and so if j could scroll down and k could scroll up, that would be awesome :-)

Use selected text as search term

Awesome package! Thanks for your work!
IMHO it would be great if some text is selected it would use that as the search term. If no selection exits just use the term under the cursor as it is now.
If I try to search the docs for Math.max() and my cursor is on the max part one have to type in the Math manually.

Font Size Increase

When an API-Doc tab is opened, the font size of text in Tab headers and the tree view is increased significantly. Closing the API-Doc tab returns the fonts to normal, but closes the right pane including other open tabs in the pane.

Before

After

Doesn't find the right spot

I installed api-docs 0.0.3 and I enabled Python. I disabled the keybindings. I used Command-P to invoke the API Docs Search function, and I entered "re.search". This suggested re.search() as one of the options, which is good. I selected it. This opens the page for the module re in the browser, but it doesn't scroll to the place where re.search() is documented.

I think it should scroll to the right spot.

"No matches found" for all

The plugin not working. Not give results for any search.

Copy from doc

When browsing doc, copy is not doing anything. It leaves copy paste buffer untouched.
Even contextual menu does not permit copy of what's selected.

Can't tell for sure if it comes from my atom setup of from the package itself.

Entries in configuration section are doubled in few cases

I believe it's related to versioning.
Problem touches languages like Clojure (2), Django (2), Node.js (2), and Symfony (3).

hitting ctrl-d does not open up api doc

Hitting ctrl-d does nothing at all.
I've also tried adding a keymap for an unused key mapping, such as 'ctrl-q': 'api-docs:search-under-cursor', and this also did nothing at all.
It appears you must hit ctrl-shift-p, then select your app from the command menu, and then select which doc you want to view, and then finally the doc opens. This is not ideal.

[Feature Requests] option to browse documentation independent of code

First thanks for starting this.

It would be great to be able to browse the the documentation independent of code. Somewhat similar to https://devdocs.io/offline.

set type in function parameters?

I think the syntax of the following lines in docset.js are wrong. Does JavaScript support type set in function parameters?

setEnabled_(enabled : boolean) {

queryAll() : Array<Object> {

Unhandled promise rejection errors in Console

Hi there,

I'm finding these errors in the console whenever the package gets activated:

The key binding has clearly been registered, however, even though it is being overridden by the binding from find-and-replace:

Win7, 64bit, Atom v209.

Anything else I can provide to help analyze the issue?

The api docs are not showing in atom editor

If I press the ctrl-d and it shows the type box and search some basic things of the installed docs nothing shows

Closing the browser on a split pane closes all files on pane

Example:
I have a css file on the left and a js file on the right pane. Now when i try to open the API documentation browser for document.documentElement from the js file it opens the browser as expected. But when i close that browser tab, it closes the js file with it and all other files on that split pane, only css file (and other files on left pane) are opened! Am i missing something?

I need some help, anybody ??

It simply doesn't work in atom,just the browser, everything is not updated

Narrow search to language of the current file

Currently the search results include all languages enabled on the settings page. I would be more helpful to only show the results which match the language of the current file and hide all other languages.

Code fragments have dark background on Atom default Mac theme

All code fragments (<code> elements) have dark background on the Atom default theme on Mac (it may be the default theme for the other OS as well).

Issue with Atom Material

Hi,
using Atom Material theme, there is an issue with the color of the font. It is grey on white making it hardly readable. Is there some way to tweak the font color?

Here's a screen

learning freakin' Meteor

Thank you.

[Q] docsets stored ?

where is documentation stored ?
I lost all of the documentation, even I disabled and re-enabled it in option. it won't to re-download the documentation packages. and now, nothing shows up when I call ctrl+d

The doc tab title retains "Loading..." forever

The doc has loaded — the tab title is still "Loading...".

There is no setting to select which languages are enabled

In the settings page it says that "You might need to enable specific languages in the settings page of this package." but there is no setting to select which languages are enabled; there is only a dropdown menu to select the theme of the package.

will it add php support?

no php support in current version. plz add it, thanks.

JS can not work

Uncaught Error: Cannot find module 'atom-space-pen-views'

Open Atom

Atom: 1.24.0 x64
Electron: 1.6.16
OS: Mac OS X 10.12.6
Thrown From: api-docs package 0.0.6

Stack Trace

Uncaught Error: Cannot find module 'atom-space-pen-views'

At module.js:472

Error: Cannot find module 'atom-space-pen-views'
    at Module._resolveFilename (module.js:470:15)
    at Module._resolveFilename (/Applications/Atom.app/Contents/Resources/electron.asar/common/reset-search-paths.js:35:12)
    at Function.get_Module._resolveFilename (/Applications/Atom.app/Contents/Resources/app/src/module-cache.js:354:58)
    at Module.require (/app.asar/static/index.js:40:43)
    at require (/Applications/Atom.app/Contents/Resources/app/src/native-compile-cache.js:66:33)
    at /packages/api-docs/src/query_view.js:4:24)
    at /packages/api-docs/src/query_view.js:106:28)
    at Module.get_Module._compile (/Applications/Atom.app/Contents/Resources/app/src/native-compile-cache.js:106:36)
    at Object.value [as .js] (/Applications/Atom.app/Contents/Resources/app/src/compile-cache.js:239:29)
    at Module.load (module.js:488:32)
    at tryModuleLoad (module.js:447:12)
    at Function.Module._load (module.js:439:3)
    at Module.require (/app.asar/static/index.js:47:45)
    at require (/Applications/Atom.app/Contents/Resources/app/src/native-compile-cache.js:66:33)
    at Application.lazyLoad_ (/packages/api-docs/src/main.js:57:19)

Commands

Non-Core Packages

api-docs 0.0.6 
apiary-highlighter 0.4.0 
atom-ide-ui 0.8.1 
atom-latex 0.8.4 
atom-material-syntax-light 0.4.6 
atom-material-ui 2.1.1 
atom-realtime-collaboration 0.7.1 
atom-spotify2 2.1.2 
autocomplete-paths 2.12.2 
busy-signal 1.4.3 
color-picker 2.2.5 
docblockr 0.13.6 
docker 0.8.0 
editorconfig 2.2.2 
emmet 2.4.3 
emmet-jsx-css-modules 1.0.0 
git-plus 7.10.0 
go-debug 1.6.0 
go-plus 5.8.2 
go-signature-statusbar 1.2.3 
hyperclick 0.0.0 
ide-typescript 0.7.2 
intentions 1.1.5 
language-api-blueprint 1.0.2 
language-jsx 0.1.1 
language-latex 1.1.1 
linter 2.2.0 
linter-api-blueprint 0.4.0 
linter-eslint 8.4.1 
linter-golinter 1.2.2 
linter-ui-default 1.6.10 
monokai 0.24.0 
Pompomodoro 1.0.0 
svg-preview 0.12.1 
wakatime 7.0.4 
Zen 0.18.0

Can't find language selection in settings

Hi,

I've installed api-docs 0.0.5, and I only have the theme setting in settings panel of this package, but there's no option to select frameworks and languages we want to enable, is it normal ?

I have keybindings activation setting too.

Thank you

sharvil / api-docs Goto Github PK

api-docs's People

Contributors

Stargazers

Watchers

Forkers

api-docs's Issues

Stack Trace

Commands

Config

Installed Packages

Stack Trace

Commands

Config

Installed Packages

Steps to reproduce

Stack Trace

Commands

Config

Installed Packages

Stack Trace

Commands

Config

Installed Packages

Stack Trace

Commands

Config

Installed Packages

Stack Trace

Commands

Non-Core Packages

Recommend Projects

Recommend Topics

Recommend Org