Project

General

Profile

Bug #12813

documentation inconsistency

Added by Andrei Gaponenko almost 5 years ago. Updated almost 5 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
Kyle Knoepfel
Target version:
-
Start date:
05/27/2016
Due date:
% Done:

100%

Estimated time:
Spent time:
0.50 h
Duration:

Description

Hello,
This document

https://cdcvs.fnal.gov/redmine/attachments/download/29136/quick_start_v3.pdf

in section 10.2.2 states "the contents of a1 have been erased"
and shows "a1:{}" in the second code fragment.
According to 10.1 not just the contents but also the name "a1" should be gone,
and there should be no empty a1 table.

Andrei

History

#1 Updated by Kyle Knoepfel almost 5 years ago

  • Status changed from New to Resolved
  • Assignee set to Kyle Knoepfel
  • % Done changed from 0 to 100

Thank you for noticing the inconsistency. Below is the corrected documentation, which will be included in the next revision of the FHiCL-3 document.

Use of @erase on a name at a higher nesting level than that of a protected name ignores the protection of the item. For example:

a1: { b: { x @protect_ignore: 7 } }
a2: { b @protect_ignore: { x: 7 } }
a1.b: @erase
a2.b: @erase
is equivalent to
a1: {}
a2: { b @protect_ignore: { x: 7 } }
where the contents of a1 have been erased, and those of a2 have been retained.

Also available in: Atom PDF