Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

[ios, docs] Fix formatting in Predicates & Expressions guide #11574

Merged
merged 1 commit into from
Mar 30, 2018

Conversation

friedbunny
Copy link
Contributor

@friedbunny friedbunny commented Mar 30, 2018

Follow-up to #11472.

  • Code ticks within HTML tables do not convert to code blocks.
  • Pipes within Markdown tables are interpreted as new columns, even within ticks.

/cc @1ec5 @fabian-guerra @jmkiley @captainbarbosa

- Code ticks within HTML tables do not convert.
- Pipes within Markdown tables are interpreted as new columns, even within ticks.
@friedbunny friedbunny added iOS Mapbox Maps SDK for iOS documentation labels Mar 30, 2018
@friedbunny friedbunny added this to the ios-v4.0.0 milestone Mar 30, 2018
@friedbunny friedbunny self-assigned this Mar 30, 2018
Copy link
Contributor

@1ec5 1ec5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, thanks for taking care of this! I hadn’t even gotten around to filing an issue about the formatting issues in the custom function table.

Maybe as a follow-up step sometime, we can figure out a way to reformat the custom function table as headings and prose, with separate parameter tables for each function, rather than a monolithic table that doesn’t lay out well.

@@ -36,7 +36,7 @@ The following compound operators are supported:
`NSCompoundPredicateType` | Format string syntax
--------------------------|---------------------
`NSAndPredicateType` | `predicate1 AND predicate2`<br />`predicate1 && predicate2`
`NSOrPredicateType` | `predicate1 OR predicate2`<br />`predicate1 || predicate2`
`NSOrPredicateType` | `predicate1 OR predicate2`<br /><code>predicate1 &vert;&vert; predicate2</code>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great catch!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By the way, I think \| also works here.

Copy link
Contributor Author

@friedbunny friedbunny Mar 30, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically this is a bug in jazzy’s markdown parser’s order of operations, as code || block should be wrapped first and not interpreted at all.

If you try to use an escape \ within a code block, I’d expect the behavior to be code \|\| block — this is what Github and other Markdown parsers do. Jazzy also behaves this way, except (apparently) for special Markdown control characters.

@friedbunny friedbunny added the macOS Mapbox Maps SDK for macOS label Mar 30, 2018
@friedbunny friedbunny merged commit b6866f7 into release-boba Mar 30, 2018
@friedbunny friedbunny deleted the fb-predicates-guide-formatting branch March 30, 2018 23:25
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants