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 about 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 #1

Updated by Benoît PECCATTE over 9 years ago

  • Target version set to 0.x
Actions #2

Updated by Alexis Mousset over 7 years ago

  • Category set to Documentation
Actions #3

Updated by Alexis Mousset almost 7 years ago

  • Subject changed from Reference documentation can be misleading to Ambiguous singular/plural in the generic methods docs
  • Priority set to 0
Actions #4

Updated by Alexis Mousset almost 7 years ago

  • Severity set to Minor - inconvenience | misleading | easy workaround
Actions #5

Updated by Alexis Mousset almost 7 years ago

  • Effort required set to Small
Actions #6

Updated by Benoît PECCATTE over 6 years ago

  • User visibility set to Operational - other Techniques | Technique editor | Rudder settings
  • Priority changed from 0 to 30
Actions #7

Updated by Vincent MEMBRÉ over 6 years ago

  • Target version changed from 0.x to 3.1.25
Actions #8

Updated by Benoît PECCATTE over 6 years ago

  • Priority changed from 30 to 40
Actions #9

Updated by Vincent MEMBRÉ over 6 years ago

  • Target version changed from 3.1.25 to 387
  • Priority changed from 40 to 41
Actions #10

Updated by Vincent MEMBRÉ over 6 years ago

  • Target version changed from 387 to 4.1.10
Actions #11

Updated by Vincent MEMBRÉ about 6 years ago

  • Target version changed from 4.1.10 to 4.1.11
Actions #12

Updated by Vincent MEMBRÉ almost 6 years ago

  • Target version changed from 4.1.11 to 4.1.12
  • Priority changed from 41 to 42
Actions #13

Updated by Vincent MEMBRÉ almost 6 years ago

  • Target version changed from 4.1.12 to 4.1.13
Actions #14

Updated by Vincent MEMBRÉ over 5 years ago

  • Target version changed from 4.1.13 to 4.1.14
  • Priority changed from 42 to 43
Actions #15

Updated by Benoît PECCATTE over 5 years ago

  • Target version changed from 4.1.14 to 4.1.15
Actions #16

Updated by Vincent MEMBRÉ over 5 years ago

  • Target version changed from 4.1.15 to 4.1.16
  • Priority changed from 43 to 44
Actions #17

Updated by Vincent MEMBRÉ over 5 years ago

  • Target version changed from 4.1.16 to 4.1.17
Actions #18

Updated by Vincent MEMBRÉ over 5 years ago

  • Target version changed from 4.1.17 to 4.1.18
  • Priority changed from 44 to 0
Actions #19

Updated by Vincent MEMBRÉ about 5 years ago

  • Target version changed from 4.1.18 to 4.1.19
Actions #20

Updated by Alexis Mousset about 5 years ago

  • Target version changed from 4.1.19 to 4.1.20
Actions #21

Updated by Alexis Mousset over 4 years ago

  • Target version changed from 4.1.20 to 588
Actions #22

Updated by Alexis Mousset over 4 years ago

  • Target version changed from 588 to 5.0.13
Actions #23

Updated by Vincent MEMBRÉ over 4 years ago

  • Target version changed from 5.0.13 to 5.0.14
Actions #24

Updated by Vincent MEMBRÉ over 4 years ago

  • Target version changed from 5.0.14 to 5.0.15
Actions #25

Updated by Vincent MEMBRÉ over 4 years ago

  • Target version changed from 5.0.15 to 5.0.16
Actions #26

Updated by Alexis Mousset about 4 years ago

  • Target version changed from 5.0.16 to 5.0.17
Actions #27

Updated by Vincent MEMBRÉ almost 4 years ago

  • Target version changed from 5.0.17 to 5.0.18
Actions #28

Updated by Vincent MEMBRÉ over 3 years ago

  • Target version changed from 5.0.18 to 5.0.19
Actions #29

Updated by Vincent MEMBRÉ over 3 years ago

  • Target version changed from 5.0.19 to 5.0.20
Actions #30

Updated by Vincent MEMBRÉ over 3 years ago

  • Target version changed from 5.0.20 to 797
Actions #31

Updated by Benoît PECCATTE almost 3 years ago

  • Target version changed from 797 to 6.1.14
Actions #32

Updated by Vincent MEMBRÉ over 2 years ago

  • Target version changed from 6.1.14 to 6.1.15
Actions #33

Updated by Vincent MEMBRÉ over 2 years ago

  • Target version changed from 6.1.15 to 6.1.16
Actions #34

Updated by Vincent MEMBRÉ over 2 years ago

  • Target version changed from 6.1.16 to 6.1.17
Actions #35

Updated by Benoît PECCATTE over 2 years ago

  • Project changed from 41 to Rudder
  • Category changed from Documentation to Documentation
Actions #36

Updated by Vincent MEMBRÉ over 2 years ago

  • Target version changed from 6.1.17 to 6.1.18
Actions #37

Updated by Vincent MEMBRÉ over 2 years ago

  • Target version changed from 6.1.18 to 6.1.19
Actions #38

Updated by François ARMAND about 2 years ago

  • Tracker changed from Bug to Enhancement
  • Severity deleted (Minor - inconvenience | misleading | easy workaround)
  • Priority deleted (0)
Actions #39

Updated by Vincent MEMBRÉ almost 2 years ago

  • Target version changed from 6.1.19 to 6.1.20
Actions #40

Updated by Vincent MEMBRÉ almost 2 years ago

  • Target version changed from 6.1.20 to 6.1.21
Actions #41

Updated by Vincent MEMBRÉ almost 2 years ago

  • Target version changed from 6.1.21 to old 6.1 issues to relocate
Actions #42

Updated by Vincent MEMBRÉ about 1 year ago

  • Status changed from New to Rejected
  • Regression set to No

I guess we won't change method name this easily and it has no impact

Actions

Also available in: Atom PDF