Skip to content
This repository has been archived by the owner on Sep 6, 2021. It is now read-only.

Docs for Prefs code hints #11200

Closed
6 tasks done
abose opened this issue Jun 2, 2015 · 13 comments
Closed
6 tasks done

Docs for Prefs code hints #11200

abose opened this issue Jun 2, 2015 · 13 comments

Comments

@abose
Copy link
Contributor

abose commented Jun 2, 2015

  • Update wiki pages on how to define code hints for preferences
  • JS Docs for define preference.
  • remove data.json
  • Find out core preferences that has not used the define preference API and add prefs docs.
  • Update preference WIKI pages.
  • Mail brackets committers/slack channel about the new API. Create entry in release notes for 1.4 for API change.
@abose
Copy link
Contributor Author

abose commented Jun 18, 2015

@sprintr
Copy link
Contributor

sprintr commented Jun 18, 2015

Find out core preferences that has not used the define preference API and add prefs docs.

I think @marcelgerber covered this story in #11197.

@abose
Copy link
Contributor Author

abose commented Jun 22, 2015

Yes, but I see that some properties are still left not defined as a preference. But that could go in at a later time.

@marcelgerber
Copy link
Contributor

@abose Which preferences do you still see un-defined?
From what I can tell, every preference is defined, unless you're talking about things that should be preferences but aren't (JS Code Hints comes to mind)

@abose
Copy link
Contributor Author

abose commented Jun 23, 2015

@nethip I remember you mentioned about undefined preferences, Could you specify which ones did you see as udefined?

@sprintr
Copy link
Contributor

sprintr commented Jun 23, 2015

I don't think there are any undefined preferences, since we suppress defaultExtension pref, so it got excluded from code hints. _windowsScrollFix was excluded intentionally.

@nethip
Copy link
Contributor

nethip commented Jun 23, 2015

@sprintr I am working on this story #11056 wherein we are going to display default preferences along with brackets.json side by side in the split view. Right now I am regenerating default preferences by looping through all preferences using this call PreferencesManager.getAllPreferences(). While iterating through all preferences, I found that the following preferences do not have description field.

"linting.asyncTimeout": 10000,
"linting.usePreferredOnly": false,
"codehint.TagHints": true,
"codehint.AttrHints": true,
"codehint.SpecialCharHints": true,
"codehint.CssPropHints": true,
"staticserver.port": 0,
"codehint.UrlCodeHints": true,

@marcelgerber
Copy link
Contributor

Those are the exact ones we altered in #11197.

@nethip
Copy link
Contributor

nethip commented Jun 23, 2015

@marcelgerber Yes I see that these are now going through definePreference, but the description is missing for all the properties.

@marcelgerber
Copy link
Contributor

I see, but #11201 should have fixed that.

@nethip
Copy link
Contributor

nethip commented Jun 23, 2015

@marcelgerber you are right. I must be working on my branch which might have not this change.Thanks for pointing out the PR.

@sprintr
Copy link
Contributor

sprintr commented Aug 9, 2015

I believe this can now be closed since all the checklist items are done.

@abose
Copy link
Contributor Author

abose commented Aug 10, 2015

Thanks @sprintr . Closing as done.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

5 participants
@nethip @marcelgerber @sprintr @abose and others