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: improve usage guide for selective readers #1406

Merged
merged 1 commit into from
Oct 2, 2022

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Oct 2, 2022

Some users (including me) tend to read only code blocks that contains actual code (and not data structures).
Thus it is easily missed that User is a custom/example data-structure that we defined ourselves.

This PR adds a tiny hint to the first code example, so it becomes clear that User is a example data-structure even if you read only that example.

I also considered adding the hint to all examples, but that code block is more or less the entry point so it should be sufficient to add it there.

Ref: Discord User Question

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels Oct 2, 2022
@ST-DDT ST-DDT added this to the v7 - Current Major milestone Oct 2, 2022
@ST-DDT ST-DDT requested review from a team October 2, 2022 10:19
@ST-DDT ST-DDT self-assigned this Oct 2, 2022
@codecov
Copy link

codecov bot commented Oct 2, 2022

Codecov Report

Merging #1406 (0048de2) into main (a17872b) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1406   +/-   ##
=======================================
  Coverage   99.62%   99.62%           
=======================================
  Files        2165     2165           
  Lines      241432   241432           
  Branches     1017     1017           
=======================================
  Hits       240525   240525           
  Misses        886      886           
  Partials       21       21           

Copy link
Member

@Shinigami92 Shinigami92 left a comment

Choose a reason for hiding this comment

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

works 👌

@Shinigami92 Shinigami92 merged commit c51bb30 into main Oct 2, 2022
@Shinigami92 Shinigami92 deleted the docs/improve-guide-for-selective-readers branch October 2, 2022 11:55
wael-fadlallah pushed a commit to wael-fadlallah/faker that referenced this pull request Oct 14, 2022
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
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants