Add release notes for 0.26 #529
Merged
Conversation
This file contains 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
bioball
force-pushed
the
release-notes-0.26.0
branch
6 times, most recently
from
56ca690
to
3051a7b
Compare
bioball
commented
Jun 14, 2024
| <option value="http://xmlns.jcp.org/" /> | ||
| </list> | ||
| </option> | ||
| </inspection_tool> |
There was a problem hiding this comment.
This is intentional; added this in order to suppress a warning in pkl:EvaluatorSettings
bioball
force-pushed
the
release-notes-0.26.0
branch
2 times, most recently
from
55aef06
to
72b4d23
Compare
bioball
force-pushed
the
release-notes-0.26.0
branch
from
72b4d23
to
48a2d7e
Compare
bioball
force-pushed
the
release-notes-0.26.0
branch
from
eb47a6f
to
14ef858
Compare
holzensp
approved these changes
Jun 14, 2024
| 1. xref:pkl-cli:index.adoc#settings-file[Settings file] | ||
| 2. xref:language-reference:index.adoc#projects[PklProject file] | ||
| 3. `--http-proxy` and `--http-no-proxy` CLI flags | ||
|
|
There was a problem hiding this comment.
The below point about the additions of http to pkl.settings is a bit isolated. I think this is the better context to put it;
Suggested change
| This means that module `pkl.settings` now has a new property `http: Http?`, where users can configure their machine's HTTP(S) proxy settings for Pkl. | |
Comment on lines
177
to
180
|
|
||
| ==== New property in `pkl.settings` | ||
|
|
||
| Module `pkl.settings` has new property `http: Http?`. |
There was a problem hiding this comment.
Suggestion: part of suggestion above to move this into HTTP(S) proxy description;
Suggested change
| ==== New property in `pkl.settings` | |
| Module `pkl.settings` has new property `http: Http?`. |
There was a problem hiding this comment.
This section is meant to list all the changes made to the stdlib, so this doens't really seem out of place to me. But to help with the disjointed-ness, I'll add a section to this to link to the HTTP proxy section in the noteworthy. Also, changed this to bullet points instead of sub-sections.
Comment on lines
182
to
189
| ==== New module: `pkl.EvaluatorSettings` | ||
|
|
||
| A new standard library module link:https://pkl-lang.org/package-docs/pkl/current/EvaluatorSettings.html[`pkl.EvaluatorSettings`] is added. | ||
| This module can be considered as having moved class https://pkl-lang.org/package-docs/pkl/0.25.3/Project/EvaluatorSettings.html[`pkl.Project.EvaluatorSettings`]. | ||
|
|
||
| ==== class `EvaluatorSettings` in `pkl.Project` changed to typealias | ||
|
|
||
| `EvaluatorSettings` within module `pkl.Project` is now a typealias for module class `pkl.EvaluatorSettings`, and is deprecated. |
There was a problem hiding this comment.
This, I'd keep here, but the descriptions under Noteworthy are all quite structural, rather than related to their purpose. I'd combine these
Suggested change
| ==== New module: `pkl.EvaluatorSettings` | |
| A new standard library module link:https://pkl-lang.org/package-docs/pkl/current/EvaluatorSettings.html[`pkl.EvaluatorSettings`] is added. | |
| This module can be considered as having moved class https://pkl-lang.org/package-docs/pkl/0.25.3/Project/EvaluatorSettings.html[`pkl.Project.EvaluatorSettings`]. | |
| ==== class `EvaluatorSettings` in `pkl.Project` changed to typealias | |
| `EvaluatorSettings` within module `pkl.Project` is now a typealias for module class `pkl.EvaluatorSettings`, and is deprecated. | |
| ==== `EvaluatorSettings` moved to its own module. | |
| A new standard library module link:https://pkl-lang.org/package-docs/pkl/current/EvaluatorSettings.html[`pkl.EvaluatorSettings`] is added. | |
| This module can be considered as having moved class https://pkl-lang.org/package-docs/pkl/0.25.3/Project/EvaluatorSettings.html[`pkl.Project.EvaluatorSettings`]. | |
| For backwards compatibility, `pkl.Project` now has a `typealias EvaluatorSettings` pointing to the new module, but it is marked `@Deprecated`. |
| +const isValid = true | ||
| ---- | ||
|
|
||
| If the property can't be marked as `const` (maybe because it is amended somewhere downstream), another fix is to self-import the enclosing module. |
There was a problem hiding this comment.
That seems worth a warning that downstream breakage is likely, no?
There was a problem hiding this comment.
Reworded this a bit
HT154
reviewed
Jun 14, 2024
bioball
commented
Jun 14, 2024
Co-authored-by: Philip K.F. Hölzenspies <holzensp@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What the title says!