displayType From memory, placement refers to the same display type as in the

If we have a shape type Test, to hide it from the edit screen we do this

{
    "Test_Edit": {
        "place": "-"
    }
}

To hide it from being displayed on Summary display type:

{
    "Test": {
        "displayType": "Summary",
        "place": "-"
    }
}

Did I misunderstand your request or is my assessment is invalid?

@MikeAlhayek, I agree with the examples you provided. The typical display types are Detail, Summary, etc.

My confusion comes from this part of the documentation introduce in commit c5ed897:

Specifically, in this line:

This might further highlight the issue:

The "DisplayType" in [ContentPart]-[ContentField]_[DisplayType]__[DisplayMode] seems to refer to something different than what we typically refer to as "display types" (e..g Detail, Summary, etc.).

Instead, it seems to the literal _Display__ "display separator" seen here:

Or the literal _Edit__ separator built up here:

I think this is mostly just a case of using the wrong terminology. The _Display__ and _Edit__ separators aren't display types, are they? If not, is there a better general term that applies to those separators?

Or should we just replace:
[ContentPart]-[ContentField]_[DisplayType]__[DisplayMode]

with:
[ContentPart]-[ContentField]_Display__[DisplayMode]
(this ignores the _Edit__ case, but seems to be consistent with elsewhere in the documentation, see here and here)

Hummm, TextField_Summary is not consistent with what I expected.

Did you actually try it? Is the document you referenced TextFiels_Summary is the correct shape type for fields in Summary display type? I expect the shape to be TextField not TextField_Summary.

@MikeAlhayek, the issue is specifically with the terminology in commit c5ed897, so it only comes into play when dealing with display modes. I agree that the documentation is correct when not using a display mode, as in your example.

I have tried this and can confirm that including the display type in the shape type does not work, so the documentation should be corrected.

The documentation states:

The Shape must include the display type. For example TextField_Display

As you said, Summary and Detail are display types. Display is not a display type, so what is it?

The documentation also provides this pattern shape type:
[ContentPart]-[ContentField]_[DisplayType]__[DisplayMode]

Using the example in the documentation, I add a "heading" display mode to the TextField. I have a content part Blog with a MyField TextField using the Heading display mode.

Using the documented pattern, this would mean the shape type should be Blog-MyField-TextField_Detail__Header or Blog-MyField-TextField_Summary__Header, depending on the display type.

This is incorrect.

The correct shape type is Blog-MyField-TextField_Display__Header. This matches the actual example in the documentation.

The issue is the pattern in the documentation ([ContentPart]-[ContentField]_[DisplayType]__[DisplayMode]), incorrectly suggests the display type is part of the shape type.

It would be more accurate to use this pattern in the documentation: [ContentPart]-[ContentField]_Display__[DisplayMode].

I can submit a PR for that change, but that doesn't capture that either _Display__ or _Edit__ would presumably work, depending on whether you're placing the editor or the display.

Please submit a PR to correct the docs. Just be sure to test out the updated docs so that the example you'll provide will be valid

We triaged this issue and set the milestone according to the priority we think is appropriate (see the docs on how we triage and prioritize issues).

This indicates when the core team may start working on it. However, if you'd like to contribute, we'd warmly welcome you to do that anytime. See our guide on contributions here.