Documentation for nxFileLine resource

Open
#65 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
powershell
Domain
documentation

Research direction

Start with source/Classes/1.DscResources/05.nxFileLine.ps1 at lines 22-27 and trace how LinePattern, AddLineMode, and DoesNotContainPattern are handled. Document the required LinePattern format, AddLineMode behavior, and their interaction with DoesNotContainPattern; done means the resource documentation answers all three questions with usage notes.

Written by the indexing model from the issue text.

Description

https://github.com/Azure/nxtools/blob/8eed31dbccfe0f2d98d93451ee3d3c9d4f031d73/source/Classes/1.DscResources/05.nxFileLine.ps1#L22-L27

Add usage notes for these two parameters.
What format does the LinePattern require?
What is the behavior of AddLineMode?
What happens if you use these with DoesNotContainPattern?

Dominant language
PowerShell
Stars
20
Forks
22
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Azure/nxtools

All issues in Azure/nxtools

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.