Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Formatting: "Fields" and "Values" as non-header #302

Merged
merged 1 commit into from
Jan 19, 2022

Conversation

scmcca
Copy link
Contributor

@scmcca scmcca commented Jan 11, 2022

The titles of "Fields" and "Values" above GTFS Realtime spec tables are currently treated as headings (####). This creates a fragmented auto-generated table of contents for users navigating between elements in the spec (see screenshot from GitHub below).

Screen Shot 2022-01-10 at 9 30 55 PM

To improve the navigability of the spec, this PR proposes to bold the titles of "Fields" and "Values" instead. Bolded titles are not included in auto-generated TOCs.

As this is a minor formatting fix, I'll leave 7 days of discussion. If anyone wishes a vote be held, please indicate so in the discussion and we'll follow the specification amendment process. If not, I will merge the formatting fix with no vote.

Looking forward to feedback. Thanks!

@scmcca scmcca added the GTFS Realtime Issues and Pull Requests that focus on GTFS Realtime label Jan 11, 2022
@gcamp
Copy link
Contributor

gcamp commented Jan 11, 2022

👍 No need for a vote imo

@barbeau
Copy link
Collaborator

barbeau commented Jan 11, 2022

👍 and I agree this is a simple formatting change and no vote is needed.

@paulswartz
Copy link
Contributor

👍

@scmcca scmcca merged commit 23d877e into google:master Jan 19, 2022
scmcca pushed a commit to MobilityData/transit that referenced this pull request Feb 11, 2022
commit 2e6887e
Author: scmcca <[email protected]>
Date:   Wed Feb 2 12:42:10 2022 -0500

    [Formatting fix] Add newlines before lists

    Improved syntax for different markdown parsers

commit 0033573
Author: Tristram Gräbener <[email protected]>
Date:   Fri Jan 28 15:54:00 2022 +0100

    Specify that the filename are case sensitive (google#300)

    Closes google#297

commit 23d877e
Author: scott christian mccallum <[email protected]>
Date:   Tue Jan 18 19:09:46 2022 -0500

    "Fields" and "Values" as non-header (google#302)
isabelle-dr pushed a commit to MobilityData/transit that referenced this pull request Dec 19, 2023
* Squashed commit of the following:

commit 2e6887e
Author: scmcca <[email protected]>
Date:   Wed Feb 2 12:42:10 2022 -0500

    [Formatting fix] Add newlines before lists

    Improved syntax for different markdown parsers

commit 0033573
Author: Tristram Gräbener <[email protected]>
Date:   Fri Jan 28 15:54:00 2022 +0100

    Specify that the filename are case sensitive (google#300)

    Closes google#297

commit 23d877e
Author: scott christian mccallum <[email protected]>
Date:   Tue Jan 18 19:09:46 2022 -0500

    "Fields" and "Values" as non-header (google#302)

* Squashed commit of the following:

commit 9d5ebf1
Author: Guillaume Campagna <[email protected]>
Date:   Tue Jul 26 17:09:35 2022 -0400

    Add trip-to-trip transfers with in-seat option (google#303)

    * Add trip-to-trip transfers with in-seat option

    * Fix stop_id are **Conditionally Required** and formatting

    * Add clarification about potential conflict

    * Fix typo

    Co-authored-by: Leonard Ehrenfried <[email protected]>

    Co-authored-by: Nicholas Paun <[email protected]>
    Co-authored-by: Leonard Ehrenfried <[email protected]>

commit a132709
Author: McKenzie Maidl <[email protected]>
Date:   Tue Jul 26 13:58:04 2022 -0700

    addition of cause_detail and effect_detail to the spec (google#332)

commit 8993a24
Author: Zsombor Welker <[email protected]>
Date:   Mon Jul 25 14:49:40 2022 +0200

    Add WheelchairAccessible documentation (google#340)

* Update README.md (#63)

* issue templates

* update use cases section

* update contact links

* rename

* Delete .github/ISSUE_TEMPLATE/spec_improvement.yml

---------

Co-authored-by: scmcca <[email protected]>
Co-authored-by: omar-kabbani <[email protected]>
Co-authored-by: Emma Jae Blue <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
GTFS Realtime Issues and Pull Requests that focus on GTFS Realtime
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants