Update property list of Map component#2733
Merged
Conversation
Contributor
|
Note
|
| Cohort / File(s) | Summary |
|---|---|
Map Component Documentation content/altinn-studio/v8/reference/ux/components/Map/_index.en.md, content/altinn-studio/v8/reference/ux/components/Map/_index.nb.md |
Replaced autogenerated component properties sections with static Markdown tables detailing Map component attributes, descriptions, and types. Removed dynamic shortcode generators and updated configuration notice formatting across English and Norwegian Bokmål documentation pages. |
Estimated code review effort
🎯 2 (Simple) | ⏱️ ~10 minutes
Poem
📍 The map speaks clear, no shortcuts now,
Static tables show the way,
Properties laid bare and bright,
From dynamic mist to structured light,
Documentation finds its sight! 🗺️
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
| Check name | Status | Explanation |
|---|---|---|
| Description Check | ✅ Passed | Check skipped - CodeRabbit’s high-level summary is enabled. |
| Title check | ✅ Passed | The title accurately summarizes the main change: updating the Map component's property list documentation in both English and Norwegian Bokmål files. |
| Docstring Coverage | ✅ Passed | No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. |
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches
🧪 Generate unit tests (beta)
- Create PR with unit tests
- Post copyable unit tests in a comment
- Commit unit tests in branch
feature/map-centerLocation-expression
Tip
Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands and usage tips.
Merged
19 tasks
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (2)
content/altinn-studio/v8/reference/ux/components/Map/_index.nb.md (1)
117-117: "bli laget" er lite idiomatisk norsk i denne sammenhengen"skal bli laget som en oppsummering" lyder unaturlig. "Rendres" eller "vises" er mer naturlige valg i teknisk dokumentasjon.
✏️ Forslag til retting
-| `renderAsSummary` | boolean | Boolean eller uttrykk som indikerer om komponenten skal bli laget som en oppsummering. Standard er `false`. +| `renderAsSummary` | boolean | Boolean eller uttrykk som indikerer om komponenten skal rendres som en oppsummering. Standard er `false`.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/altinn-studio/v8/reference/ux/components/Map/_index.nb.md` at line 117, Oppdater beskrivelsen for feltet `renderAsSummary` slik at den erstatter den lite idiomatiske frasen "skal bli laget som en oppsummering" med et mer naturlig teknisk uttrykk, for eksempel "rendres som en oppsummering" eller "vises som en oppsummering", og behold informasjonen om at standardverdien er `false` og at feltet kan være et uttrykk eller boolean.content/altinn-studio/v8/reference/ux/components/Map/_index.en.md (1)
123-123: Repetitive "will be replaced" in the same sentenceThe
layers.urldescription uses "will be replaced" twice in adjacent clauses. Consider rephrasing the second occurrence.✏️ Suggested rewrite
-| `layers.url` | string | The URL to a map tile. `{z}/{x}/{y}` will be replaced with tile coordinates, `{s}` will be replaced with a random subdomain if subdomains are given. +| `layers.url` | string | The URL to a map tile. `{z}/{x}/{y}` will be replaced with tile coordinates; `{s}` with a random subdomain if subdomains are given.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/altinn-studio/v8/reference/ux/components/Map/_index.en.md` at line 123, The description for layers.url repeats "will be replaced" twice; update the text for the `layers.url` property so the first clause keeps "The URL to a map tile." and the second clause is rephrased to remove the duplicate phrasing (e.g., "where `{z}/{x}/{y}` are replaced with tile coordinates and `{s}` is substituted with a random subdomain if subdomains are provided"), ensuring it still references `{z}/{x}/{y}` and `{s}` and preserves meaning.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@content/altinn-studio/v8/reference/ux/components/Map/_index.en.md`:
- Line 108: The description for the `readOnly` property uses "read only" without
a hyphen; update the text in the `readOnly` property description (the line
containing `readOnly`) to use the compound adjective "read-only" everywhere
(e.g., "presented as read-only" and "read-only fields") so the phrasing conforms
to standard English hyphenation rules.
In `@content/altinn-studio/v8/reference/ux/components/Map/_index.nb.md`:
- Line 102: The Norwegian doc for Map component notes that
dataModelBindings.simpleBinding must be a string but the English version
(_index.en.md) lacks this restriction; update _index.en.md to mirror the NB text
by adding the phrase that the bound data model field must be of type string
(referencing dataModelBindings.simpleBinding) OR, if there is no actual schema
constraint, remove the sentence from _index.nb.md so both language files match;
ensure the change mentions dataModelBindings.simpleBinding explicitly for
clarity.
- Around line 115-116: The descriptions for pageBreak.breakAfter and
pageBreak.breakBefore use the incorrect neuter article "et sidebrytning"; update
both strings to use the correct common/gendered article "en sidebrytning" so the
sentences read "...indikerer om en sidebrytning skal legges til etter
komponenten" and "...indikerer om en sidebrytning skal legges til før
komponenten" respectively.
- Line 111: Oppdater beskrivelsen for grid.innerGrid slik at teksten får korrekt
konjunksjon og samskriving: endre "så som input felt dropdown" til "så som
inputfelt og dropdown" i dokumentasjonsteksten for grid.innerGrid (se
beskrivelsen i Map/_index.nb.md), slik at både ordet "inputfelt" er skrevet som
ett ord og "og" legges til mellom eksemplene.
---
Nitpick comments:
In `@content/altinn-studio/v8/reference/ux/components/Map/_index.en.md`:
- Line 123: The description for layers.url repeats "will be replaced" twice;
update the text for the `layers.url` property so the first clause keeps "The URL
to a map tile." and the second clause is rephrased to remove the duplicate
phrasing (e.g., "where `{z}/{x}/{y}` are replaced with tile coordinates and
`{s}` is substituted with a random subdomain if subdomains are provided"),
ensuring it still references `{z}/{x}/{y}` and `{s}` and preserves meaning.
In `@content/altinn-studio/v8/reference/ux/components/Map/_index.nb.md`:
- Line 117: Oppdater beskrivelsen for feltet `renderAsSummary` slik at den
erstatter den lite idiomatiske frasen "skal bli laget som en oppsummering" med
et mer naturlig teknisk uttrykk, for eksempel "rendres som en oppsummering"
eller "vises som en oppsummering", og behold informasjonen om at standardverdien
er `false` og at feltet kan være et uttrykk eller boolean.
ℹ️ Review info
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
content/altinn-studio/v8/reference/ux/components/Map/_index.en.mdcontent/altinn-studio/v8/reference/ux/components/Map/_index.nb.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updates the property list of the Map component after changes made in this PR.
Summary by CodeRabbit