Project

General

Profile

Actions

Bug #12157

closed

condition_from_expression documentation does not clearly state how to use it

Added by Nicolas CHARLES over 6 years ago. Updated over 2 years ago.

Status:
Released
Priority:
N/A
Category:
Documentation
Target version:
Severity:
UX impact:
User visibility:
Operational - other Techniques | Technique editor | Rudder settings
Effort required:
Small
Priority:
0
Name check:
Fix check:
Regression:

Description

This generic method works in a different manner than the other generic method (it always defines a _kept result class, and it's the contition_prefix_true or _false that is the real result), and this is
  1. surprising
  2. not clearly documented

We can't do much about the first one, but we can improve the documentation with real world examples, that will make it more easy to use (and hopefully less surprising)


Subtasks 1 (0 open1 closed)

User story #12237: Add examples in documentation of condition_from_expression ReleasedNicolas CHARLESActions
Actions #1

Updated by Benoît PECCATTE over 6 years ago

  • Subject changed from condiftion_from_expression documentation does not clearly state how to use it to condition_from_expression documentation does not clearly state how to use it
Actions #2

Updated by Benoît PECCATTE over 6 years ago

As a side note, that's how all condition_* methods work, so we should document all of them

Actions #3

Updated by Benoît PECCATTE over 6 years ago

  • Status changed from New to In progress
  • Assignee set to Benoît PECCATTE
Actions #4

Updated by Benoît PECCATTE over 6 years ago

  • Status changed from In progress to Pending technical review
  • Assignee changed from Benoît PECCATTE to Alexis Mousset
  • Pull Request set to https://github.com/Normation/ncf/pull/709
Actions #5

Updated by Benoît PECCATTE over 6 years ago

  • Status changed from Pending technical review to Pending release

Applied in changeset commit:3909741e5175bc9da9ea6ac9abe8db397280bba0.

Actions #6

Updated by Alexis Mousset over 6 years ago

  • Status changed from Pending release to Released

This bug has been fixed in Rudder 4.1.11, 4.2.5 and 4.3.0~rc3 which were released today.

Actions #7

Updated by Alexis Mousset over 2 years ago

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

Also available in: Atom PDF