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

docs: Function Reference Proofreads #919

Merged
merged 19 commits into from
Dec 19, 2023
Merged

docs: Function Reference Proofreads #919

merged 19 commits into from
Dec 19, 2023

Conversation

schloerke
Copy link
Collaborator

Fixes #880
Fixes #917

cc @garrettgman

garrettgman and others added 17 commits December 7, 2023 12:59
* main: (24 commits)
  docs: Use definition lists for parameter descriptions to enable full markdown support (#901)
  docs(layout_columns): Add example app (#903)
  fix(layout_columns): Remove use of enum for breakpoints (#912)
  Express: don't automatically put strings in a `<pre>` block (#905)
  Deprecate `nav()` in favor of `nav_panel()` (#876)
  chore: Remove unused import
  refactor(layout_column_wrap): Use helper for wrapping children (#910)
  fix(layout_columns): Don't apply fillable class to layout container (#909)
  Add output to React template (#908)
  fix(layout_columns): Add missing `bslib-mb-spacing` class (#906)
  Custom component template updates (#874)
  fix(layout_columns): If the breakpoint name is an enum, need to collect the value (#902)
  chore: exclude `_dev/` folder (#897)
  feat: Add `ui.layout_columns()` (#856)
  Update VS Code settings file
  Express: change default page function to page_fixed (#892)
  Better messages for `AttributeError` in Shiny Express (#888)
  Fix 0.6.0 release date
  Fix failing express tests (#887)
  Explain why function is called twice
  ...
@schloerke schloerke added this to the v0.7.0 milestone Dec 18, 2023
@schloerke schloerke changed the title Proofreads experimental section docs: Function Reference Proofreads Dec 18, 2023
@schloerke schloerke self-assigned this Dec 18, 2023
description = docstring_parts[0].value

# ## Approach: Always return the full description!
return description
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This will now always display the full description rather than being randomly cut off

Comment on lines +453 to +459
# wrapper
# A function (which returns a UI element) to call on unnamed arguments in `*args`
# which are not already card item(s) (like :func:`~shiny.ui.card_header`,
# :func:`~shiny.experimental.ui.card_body`, etc.). Note that non-card items are
# grouped together into one `wrapper` call (e.g. given `card("a", "b",
# card_body("c"), "d")`, `wrapper` would be called twice, once with `"a"` and
# `"b"` and once with `"d"`).
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Were these docs just not removed?

(Same for all changes in this file)

@schloerke schloerke requested a review from wch December 18, 2023 21:38
@schloerke schloerke marked this pull request as ready for review December 18, 2023 21:38
@schloerke
Copy link
Collaborator Author

@wch , just want to make sure removing the docs within express layout.py is accurate. Otherwise the underlying PR from Garrett LGTM

@schloerke
Copy link
Collaborator Author

Merging to get v0.6.1 milestone finished up

@schloerke schloerke merged commit b2a60dc into main Dec 19, 2023
25 checks passed
@schloerke schloerke deleted the gman-docs branch December 19, 2023 14:56
@schloerke
Copy link
Collaborator Author

Thank you @garrettgman !

schloerke added a commit that referenced this pull request Dec 19, 2023
* main: (76 commits)
  Add shiny/templates to MANIFEST.in files (#926)
  docs: Function Reference Proofreads (#919)
  Fix failing deploy tests (#925)
  Add GitHub sources to shiny create
  Make changelog styling more consistent
  Function reference edits (#857)
  docs: Use definition lists for parameter descriptions to enable full markdown support (#901)
  docs(layout_columns): Add example app (#903)
  fix(layout_columns): Remove use of enum for breakpoints (#912)
  Express: don't automatically put strings in a `<pre>` block (#905)
  Deprecate `nav()` in favor of `nav_panel()` (#876)
  chore: Remove unused import
  refactor(layout_column_wrap): Use helper for wrapping children (#910)
  fix(layout_columns): Don't apply fillable class to layout container (#909)
  Add output to React template (#908)
  fix(layout_columns): Add missing `bslib-mb-spacing` class (#906)
  Custom component template updates (#874)
  fix(layout_columns): If the breakpoint name is an enum, need to collect the value (#902)
  chore: exclude `_dev/` folder (#897)
  feat: Add `ui.layout_columns()` (#856)
  ...
schloerke added a commit that referenced this pull request Dec 19, 2023
* main: (36 commits)
  Add shiny/templates to MANIFEST.in files (#926)
  docs: Function Reference Proofreads (#919)
  Fix failing deploy tests (#925)
  Add GitHub sources to shiny create
  Make changelog styling more consistent
  Function reference edits (#857)
  docs: Use definition lists for parameter descriptions to enable full markdown support (#901)
  docs(layout_columns): Add example app (#903)
  fix(layout_columns): Remove use of enum for breakpoints (#912)
  Express: don't automatically put strings in a `<pre>` block (#905)
  Deprecate `nav()` in favor of `nav_panel()` (#876)
  chore: Remove unused import
  refactor(layout_column_wrap): Use helper for wrapping children (#910)
  fix(layout_columns): Don't apply fillable class to layout container (#909)
  Add output to React template (#908)
  fix(layout_columns): Add missing `bslib-mb-spacing` class (#906)
  Custom component template updates (#874)
  fix(layout_columns): If the breakpoint name is an enum, need to collect the value (#902)
  chore: exclude `_dev/` folder (#897)
  feat: Add `ui.layout_columns()` (#856)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Broken doc links Tables in documentation abruptly truncate sentences
2 participants