(DOCS) Document new and changed config functions #391
Conversation
|
|
||
| ## Synopsis | ||
|
|
||
| Returns an integer from an input string or non-integer number. |
There was a problem hiding this comment.
I'm not sure if int() needs to be capable of converting from a non-integer number, as https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/template-functions-numeric#int specifies the input as string or int (...though I can't really think of a use case for calling int() with an int)
There was a problem hiding this comment.
I think there's some value in getting return data from a resource like 1.3 and converting it to 1, but I don't fully disagree with you.
It's also worth noting that, right now, converting a number with a fractional part to an integer with this configuration function is broken - see #390 for more details.
There was a problem hiding this comment.
Thinking this over again, I think we should do one of the following:
- Allow the function to convert numbers with fractional parts to integers, and fix the implementation.
- Raise an error when the input to the function isn't a string or integer, indicating that only those two data types are supported.
I'm fine to update the docs in this PR to limit the input to a string or integer, but if DSC doesn't raise an error for other data types users can end up in a weird position. I would prefer the utility of handling strings and numbers (with and without fractional parts), but I understand if we're trying to maintain strict equivalence with the ARM template functions.
There was a problem hiding this comment.
@michaeltlombardi can you open an issue to track this?
michaeltlombardi
force-pushed
the
docs/main/config-func-docs
branch
from
be31763
to
2f433ac
Compare
michaeltlombardi
force-pushed
the
docs/main/config-func-docs
branch
2 times, most recently
from
3f4692f
to
cfaac4b
Compare
This change adds reference documentation and changelog entries for the new and updated configuration functions in DSC. It also: - Defines a few helper snippets for docs authoring, scoped to the Markdown files in the repository. - Adds maintainer comments to the changelog for using the snippets and for updating the changelog, particularly around releases.
michaeltlombardi
force-pushed
the
docs/main/config-func-docs
branch
from
cfaac4b
to
5a7f48d
Compare
PR Summary
This change adds reference documentation and changelog entries for the new and updated configuration functions in DSC.
It also:
PR Context
Prepare for next release.