Project

General

Profile

Bug #12157

condition_from_expression documentation does not clearly state how to use it

Added by Nicolas CHARLES 10 months ago. Updated 5 months ago.

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

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

User story #12237: Add examples in documentation of condition_from_expression ReleasedNicolas CHARLES

Associated revisions

Revision 3909741e (diff)
Added by Benoît PECCATTE 10 months ago

Fixes #12157: condition_from_expression documentation does not clearly state how to use it

History

#1 Updated by Benoît PECCATTE 10 months 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

#2 Updated by Benoît PECCATTE 10 months ago

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

#3 Updated by Benoît PECCATTE 10 months ago

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

#4 Updated by Benoît PECCATTE 10 months 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

#5 Updated by Benoît PECCATTE 9 months ago

  • Status changed from Pending technical review to Pending release

#6 Updated by Alexis MOUSSET 8 months 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.

Also available in: Atom PDF