[CLOSED] Docs for Prefs code hints

[core-ai-bot]

Issue by abose
Tuesday Jun 02, 2015 at 13:57 GMT
Originally opened as adobe/brackets#11200

---

• 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.

[core-ai-bot]

Comment by abose
Thursday Jun 18, 2015 at 06:50 GMT

---

Update the wikis
https://github.com/adobe/brackets/wiki/Preferences-System and https://github.com/adobe/brackets/wiki/How-to-Use-Brackets#preferences

[core-ai-bot]

Comment by sprintr
Thursday Jun 18, 2015 at 09:18 GMT

---

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

I think@MarcelGerber covered this story in #11197.

[core-ai-bot]

Comment by abose
Monday Jun 22, 2015 at 10:57 GMT

---

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

[core-ai-bot]

Comment by MarcelGerber
Monday Jun 22, 2015 at 18:23 GMT

---

@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)

[core-ai-bot]

Comment by abose
Tuesday Jun 23, 2015 at 06:25 GMT

---

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

[core-ai-bot]

Comment by sprintr
Tuesday Jun 23, 2015 at 06:48 GMT

---

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.

[core-ai-bot]

Comment by nethip
Tuesday Jun 23, 2015 at 07:25 GMT

---

@sprintr I am working on this story adobe/brackets#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,

[core-ai-bot]

Comment by MarcelGerber
Tuesday Jun 23, 2015 at 12:22 GMT

---

Those are the exact ones we altered in #11197.

[core-ai-bot]

Comment by nethip
Tuesday Jun 23, 2015 at 12:48 GMT

---

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

[core-ai-bot]

Comment by MarcelGerber
Tuesday Jun 23, 2015 at 13:03 GMT

---

I see, but #11201 should have fixed that.

[core-ai-bot]

Comment by nethip
Tuesday Jun 23, 2015 at 13:18 GMT

---

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

[core-ai-bot]

Comment by sprintr
Sunday Aug 09, 2015 at 21:07 GMT

---

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

[core-ai-bot]

Comment by abose
Monday Aug 10, 2015 at 06:06 GMT

---

Thanks@sprintr . Closing as done.