[DOCS-8435] {{role}} in apiargs represents the interface:operation, rather than the name of the arg Created: 27/Jul/16  Updated: 11/Oct/16  Resolved: 28/Sep/16

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: DOCS Q3 W10

Type: Bug Priority: Minor - P4
Reporter: Allison Reinheimer Moore Assignee: Allison Reinheimer Moore
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

giza: 0.5.6
libgiza: 0.2.7


Participants:
Days since reply: 7 years, 29 weeks ago
Story Points: 1

 Description   

For this block of yaml:

arg_name: option
name: autoIndexId
type: boolean
description: |
 
  *Default: true*. Specify false to disable the automatic creation of
  an index on the _id field.
 
  .. important::
    
     For replica sets, do not set {{role}} to ``false``.
 
  .. deprecated:: 3.2. The {{role}} option will be removed in MongoDB v3.4.
 
optional: true
interface: phpmethod
operation: MongoDB\\Database::createCollection
position: 1

Based on the behavior of the {{role}} replacement in options/settings directives, I would expect {{role}} to be replaced with autoIndexId.

{{role}} is actually replaced with :phpmethod:MongoDB\Database::createCollection.

We should fix that.


Generated at Thu Feb 08 07:56:18 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.