Title: Fix word-break in documentation · Issue #230 · googleapis/python-pubsub · GitHub
Open Graph Title: Fix word-break in documentation · Issue #230 · googleapis/python-pubsub
X Title: Fix word-break in documentation · Issue #230 · googleapis/python-pubsub
Description: Badly formatted sections of documentation where word-break causes the docs to be illegible. See screenshot examples below. Possibly expanding margins or turning off word-break for those elements could fix the problem. Environment details...
Open Graph Description: Badly formatted sections of documentation where word-break causes the docs to be illegible. See screenshot examples below. Possibly expanding margins or turning off word-break for those elements co...
X Description: Badly formatted sections of documentation where word-break causes the docs to be illegible. See screenshot examples below. Possibly expanding margins or turning off word-break for those elements co...
Opengraph URL: https://github.com/googleapis/python-pubsub/issues/230
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Fix word-break in documentation","articleBody":"Badly formatted sections of documentation where word-break causes the docs to be illegible. See screenshot examples below. Possibly expanding margins or turning off word-break for those elements could fix the problem.\r\n\r\n#### Environment details\r\n\r\n - OS type and version: macOS Mojave 10.14.6 \r\n - Browser: Chrome Version 86.0.4240.111 _and_ Brave_ Version 1.16.68 Chromium\r\n - Resolution: 1080p\r\n - Python version: `python --version` n/a\r\n - pip version: `pip --version` n/a\r\n - `google-cloud-pubsub` version: `pip show google-cloud-pubsub` n/a\r\n\r\n#### Steps to reproduce\r\n\r\n 1. Go to: https://googleapis.dev/python/pubsub/latest/publisher/api/client.html?highlight=publish#google.cloud.pubsub_v1.publisher.client.Client.publish\r\n 2. Search for `get_topic(` on page.\r\n\r\nNormal:\r\n\r\n\r\nTurn word break off:\r\n\r\n\r\nBetter but still not quite right:\r\n\r\n\r\nAnother example of difficult to read formatting:\r\n\r\n\r\n#### Code example\r\n\r\nIn inspector you can turn on and off `word-break: break-word;` for `Return type:` and see how the formatting improves.\r\n\r\n#### Stack trace\r\n\r\nn/a\r\n","author":{"url":"https://github.com/dylancaponi","@type":"Person","name":"dylancaponi"},"datePublished":"2020-10-29T20:57:04.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":4},"url":"https://github.com/230/python-pubsub/issues/230"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:ceab690a-e89a-5ea6-0262-3a7ea545d789 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 9180:199219:1F5B104:2970BE5:6A51EE3A |
| html-safe-nonce | c73b1e4eb1d604060076d3272397e54dc4e66f521cd8b768a6f7fe7edc6f6f01 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5MTgwOjE5OTIxOToxRjVCMTA0OjI5NzBCRTU6NkE1MUVFM0EiLCJ2aXNpdG9yX2lkIjoiMTczNjk2MzA2NDk1MDAyNTc4NiIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | f2935002c9ad6709107306d8fe241058b2fb225dc19daeae6ac8410a5f9904a4 |
| hovercard-subject-tag | issue:732655844 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/googleapis/python-pubsub/230/issue_layout |
| twitter:image | https://opengraph.githubassets.com/e8aa0384abc1dcae1cd83f2b0c2e926c144f0dcb7fa42192f6ebbc37fdd72c5c/googleapis/python-pubsub/issues/230 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/e8aa0384abc1dcae1cd83f2b0c2e926c144f0dcb7fa42192f6ebbc37fdd72c5c/googleapis/python-pubsub/issues/230 |
| og:image:alt | Badly formatted sections of documentation where word-break causes the docs to be illegible. See screenshot examples below. Possibly expanding margins or turning off word-break for those elements co... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | dylancaponi |
| hostname | github.com |
| expected-hostname | github.com |
| None | b9a586c06a05a7a86fc7e3f4dbd03e42f6869085879aa184aa6369456dbd50fb |
| turbo-cache-control | no-preview |
| go-import | github.com/googleapis/python-pubsub git https://github.com/googleapis/python-pubsub.git |
| octolytics-dimension-user_id | 16785467 |
| octolytics-dimension-user_login | googleapis |
| octolytics-dimension-repository_id | 226992581 |
| octolytics-dimension-repository_nwo | googleapis/python-pubsub |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 226992581 |
| octolytics-dimension-repository_network_root_nwo | googleapis/python-pubsub |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 7aed05249554b889eb33d002851a973eebcc7e91 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width