Skip to content

docs: read (complex) defaults from implementation signature #656

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

Merged
merged 6 commits into from
Mar 23, 2022

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Mar 22, 2022

This PR allows displaying potentially complex (expressions, options, arrays) default values in the docs.

Here an example with a fictional expression default value.

grafik

Here is an example from the actual docs:

Old

grafik

New

grafik

Diff

grafik

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels Mar 22, 2022
@ST-DDT ST-DDT requested a review from a team as a code owner March 22, 2022 17:28
@ST-DDT ST-DDT self-assigned this Mar 22, 2022
@ST-DDT ST-DDT force-pushed the docs/complex-defaults branch from eb3a280 to 988f61a Compare March 22, 2022 17:42
@codecov
Copy link

codecov bot commented Mar 22, 2022

Codecov Report

Merging #656 (57f481c) into main (e643835) will not change coverage.
The diff coverage is n/a.

❗ Current head 57f481c differs from pull request most recent head 94828e0. Consider uploading reports for the commit 94828e0 to get more accurate results

@@           Coverage Diff           @@
##             main     #656   +/-   ##
=======================================
  Coverage   99.33%   99.33%           
=======================================
  Files        1923     1923           
  Lines      176857   176857           
  Branches      908      908           
=======================================
  Hits       175687   175687           
  Misses       1114     1114           
  Partials       56       56           

@ST-DDT ST-DDT requested review from Shinigami92 and a team March 22, 2022 19:05
Shinigami92
Shinigami92 previously approved these changes Mar 22, 2022
@ST-DDT ST-DDT force-pushed the docs/complex-defaults branch from 53050a3 to 9426b38 Compare March 22, 2022 21:19
@ejcheng ejcheng added the s: accepted Accepted feature / Confirmed bug label Mar 23, 2022
@prisis prisis enabled auto-merge (squash) March 23, 2022 11:52
@prisis prisis merged commit 1b08de8 into main Mar 23, 2022
@Shinigami92 Shinigami92 deleted the docs/complex-defaults branch March 23, 2022 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants