pebble
  • Tutorials
  • Get the SDK
  • Guides
  • Documentation
  • Examples
  • Community
  • Blog
  • More
Privacy
Cookies
Publish
Get Updates
Follow Us
Subscribe to the Newsletter

API documentation now inside CloudPebble

  • 14 April 2014
  • Katharine Berry
  • Freshly Baked, CloudPebble
  • Comments

To help make your Pebble development experience even better, CloudPebble can now display the API documentation for any function directly in the editor view.

First up, a brief summary of each function now appears at the bottom of the autocomplete popup, explaining the purpose of that function. This could help you remember, for instance, whether you wanted to set a layer's bounds or frame.

autocomplete summary view

For more detail on any API function, you can hold down the 'alt' key (or 'option' on Macs) and click the function's name, which will show a popover including a description of the function, explanations of its parameters and return values, and any important considerations when using it:

property_animation_create_layer_frame popover

This popover can be dismissed by clicking elsewhere or hitting the Escape key.

In addition to alt-clicking, you can also produce this popover using a keyboard shortcut. If you are using a mac, that shortcut is cmd-ctrl-shift-/ (which is the same as cmd-ctrl-? on US/UK keyboards). Otherwise, use ctrl-alt-shift-/ (or ctrl-alt-?). A popover explaining the function your caret is inside will appear:

window_long_click_subscribe popover

Again, this can be dismissed using the Escape key or by clicking elsewhere.

We hope this makes creating apps for Pebble easier and more enjoyable. And if you have suggestions on how we can make your development experience better, let us know on GitHub!


You need JavaScript enabled to read and post comments.
Get Updates
Follow Us
Subscribe to the Newsletter

Categories

  • All Posts
  • #makeawesomehappen
  • At the Pub
  • Beautiful Code
  • CloudPebble
  • Down the Rabbit Hole
  • Freshly Baked
  • Timeline

Authors

  • Thomas Sarlandie
  • Niharika Bedekar
  • Jon Barlow
  • Katharine Berry
  • Cherie Williams
  • Chris Lewis
  • Team Pebble
  • Cat Haines
  • Katherine McAuliffe
  • Alex Lin
  • Alexey Komissarouk
  • Brad Murray
  • Kirby Kohlmorgen
  • Ryan Case
  • Ryan Perry-Nguyen
  • Tom Maremaa
  • Meiguro
  • Keegan Lillo
  • Ɓukasz Zalewski

Subscribe to the Pebble Developers Newsletter