Skip to content

Enhance documentation for weather locations #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tyeth wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Enhance documentation for weather locations #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cccb354
Enhance documentation for weather locations
tyeth Nov 5, 2025
637a025
fix(docs): mention where to create locations
tyeth Nov 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions app/blocks/power_ups/air_quality.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export default {
// re-run the things that use the data
block.refreshPropertyOptions({})
})
}, 1)
}, 5)
Copy link
Collaborator

@lorennorman lorennorman Dec 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why this change? (this block and weather block)

}
},

Expand All @@ -66,7 +66,7 @@ export default {

fields: {
POWER_UP_ID: {
description: "Select a location from those defined by the Air Quality Power-Up",
description: "Select a location from those defined by the Air Quality Power-Up.\n\nCreate locations via Power-Ups => Air Quality ([https://io.adafruit.com/services/air_quality](https://io.adafruit.com/services/air_quality))",
Copy link
Collaborator

@lorennorman lorennorman Dec 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use niceTemplate functionality when docs-in-js need newlines, like this:

description: `
  Select a location...

  Create locations via...
`

it'll strip the leading/trailing newlines and the leading whitespace automatically, keeps it looking like itself.

other options exist when it gets too hairy for even that, you can use the docOverrides (like the weather block), or even separate .md files.

options: [
[ "Loading locations...", "" ],
]
Expand Down
4 changes: 3 additions & 1 deletion app/blocks/power_ups/weather.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ export default {
// @ts-ignore re-run the things that use the data
block.refreshPropertyOptions({})
})
}, 1)
}, 5)
}
},

Expand Down Expand Up @@ -117,6 +117,8 @@ export default {
The list of weather locations defined in the Weather Power-Up. Select
the location you would like weather information for.

Create locations via Power-Ups => Weather ([https://io.adafruit.com/services/weather](https://io.adafruit.com/services/weather))

### \`Forecast\` and \`Metric\`
A list a weather forecasts to choose from. The weather metrics available
are different based on the chosen forecast.
Expand Down