[PR #121] [MERGED] Introduce Typed objects before referring to them #419

Closed
opened 2025-12-30 01:24:23 +01:00 by adam · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/apple/pkl/pull/121
Author: @hoxell
Created: 2/11/2024
Status: Merged
Merged: 2/13/2024
Merged by: @holzensp

Base: mainHead: doc/confusing_note_about_amending_new_properties


📝 Commits (3)

  • bc5e3f6 Introduce Typed objects before referring to them
  • 694275b Update docs/modules/language-tutorial/pages/02_filling_out_a_template.adoc
  • 05777d5 Apply suggested update to note on amending types

📊 Changes

1 file changed (+5 additions, -2 deletions)

View changed files

📝 docs/modules/language-tutorial/pages/02_filling_out_a_template.adoc (+5 -2)

📄 Description

Currently, typed objects are only briefly mentioned in the sentence stating that (typed) objects cannot be amended with new properties, only existing ones. This is unnecessarily confusing since all examples up until that point have been concerned with dynamic objects. Since the tutorial goes on to amend a dynamic object with a new property in the next section, a reader who isn't yet aware there are two types of objects might be confused by what seems to be a contradiction.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/apple/pkl/pull/121 **Author:** [@hoxell](https://github.com/hoxell) **Created:** 2/11/2024 **Status:** ✅ Merged **Merged:** 2/13/2024 **Merged by:** [@holzensp](https://github.com/holzensp) **Base:** `main` ← **Head:** `doc/confusing_note_about_amending_new_properties` --- ### 📝 Commits (3) - [`bc5e3f6`](https://github.com/apple/pkl/commit/bc5e3f6c193c92d822e7617525b0adc48b7f27cd) Introduce Typed objects before referring to them - [`694275b`](https://github.com/apple/pkl/commit/694275bb035a720db4985d888bb6b570138c64a4) Update docs/modules/language-tutorial/pages/02_filling_out_a_template.adoc - [`05777d5`](https://github.com/apple/pkl/commit/05777d57a6763a2bf49e8f3799924a4e9fde1f6a) Apply suggested update to note on amending types ### 📊 Changes **1 file changed** (+5 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `docs/modules/language-tutorial/pages/02_filling_out_a_template.adoc` (+5 -2) </details> ### 📄 Description Currently, typed objects are only briefly mentioned in the sentence stating that (typed) objects cannot be amended with new properties, only existing ones. This is unnecessarily confusing since all examples up until that point have been concerned with dynamic objects. Since the tutorial goes on to amend a dynamic object with a new property in the next section, a reader who isn't yet aware there are two types of objects might be confused by what seems to be a contradiction. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-30 01:24:23 +01:00
adam closed this issue 2025-12-30 01:24:23 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/pkl#419