Project

General

Profile

Actions

Enhancement #5736

closed

Ambiguous singular/plural in the generic methods docs

Added by Benoît PECCATTE over 9 years ago. Updated over 1 year ago.

Status:
Rejected
Priority:
N/A
Assignee:
-
Category:
Documentation
UX impact:
Suggestion strength:
User visibility:
Operational - other Techniques | Technique editor | Rudder settings
Effort required:
Small
Name check:
Fix check:
Regression:
No

Description

The documentation and api sometimes mix singular and plural.
I don't know if the problem is in the api or in the documentation.

Here are some example. I'm not certain to have catched all the cases.

A directory or multiple dirS ?

permissions_dirs

Verify if a directory has the right permissions non recursively

One line or multiple lineS ?

file_replace_lines

This is a bundle to ensure that a line in a file is replaced by another one
Signature

bundle agent file_replace_lines(file, line, replacement)

Parameters

    file: File name to edit
    line: Line to match in the file
    replacement: Line to add in the file as a replacement
Actions

Also available in: Atom PDF