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

Updated formatting of features in readme #1544

Merged
merged 1 commit into from
Mar 16, 2022

Conversation

istranic
Copy link
Contributor

🚀 🚀 Pull Request

Checklist:

  • My code follows the style guidelines of this project and the Contributing document
  • I have commented my code, particularly in hard-to-understand areas
  • I have kept the coverage-rate up
  • I have performed a self-review of my own code and resolved any problems
  • I have checked to ensure there aren't any other open Pull Requests for the same change
  • I have described and made corresponding changes to the relevant documentation
  • New and existing unit tests pass locally with my changes

Changes

@davidbuniat
Copy link
Member

agree with the problem, but solution uses the space sub-optimally

  • instead of using ### Storage Agnostic maybe give a try just Storage Agnostic or #### ...
  • Since you have single bullet point then no longer need using bullet point under section, maybe instead you can set the bullet to the * Storage Agnostic

@davidbuniat
Copy link
Member

also maybe worth leaving the feature text after the visualization, it would give discount on the full blown text content to be shown. (unless there is no way to shorten the text or the list of features)

@istranic
Copy link
Contributor Author

agree with the problem, but solution uses the space sub-optimally

  • instead of using ### Storage Agnostic maybe give a try just Storage Agnostic or #### ...
  • Since you have single bullet point then no longer need using bullet point under section, maybe instead you can set the bullet to the * Storage Agnostic

@davidbuniat I tried both. #### is too small. It looks ok, but when you skim, the features just don't pop out. The single-bullet also has the same problem. That's how it was in the old readme, and the feature does not stand out enough when it's immediately followed by text.

Do you think the formatting in the old readme is an issues at all? Maybe I'm trying to solve a problem that doesn't exist.

@istranic
Copy link
Contributor Author

also maybe worth leaving the feature text after the visualization, it would give discount on the full blown text content to be shown. (unless there is no way to shorten the text or the list of features)

@davidbuniat I don't love this, but am down to try. @mikayelh what do you think?

@codecov
Copy link

codecov bot commented Mar 15, 2022

Codecov Report

Merging #1544 (4696b3f) into main (2893b40) will increase coverage by 0.42%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1544      +/-   ##
==========================================
+ Coverage   91.75%   92.17%   +0.42%     
==========================================
  Files         193      193              
  Lines       16879    17135     +256     
==========================================
+ Hits        15487    15795     +308     
+ Misses       1392     1340      -52     
Flag Coverage Δ
unittests 92.17% <ø> (+0.42%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
hub/integrations/tests/test_pytorch_dataloader.py 95.69% <0.00%> (-1.98%) ⬇️
hub/integrations/pytorch/dataset.py 91.37% <0.00%> (-1.18%) ⬇️
conftest.py 100.00% <0.00%> (ø)
hub/cli/commands.py 100.00% <0.00%> (ø)
hub/api/tests/test_json.py 100.00% <0.00%> (ø)
hub/api/tests/test_text.py 100.00% <0.00%> (ø)
hub/tests/cache_fixtures.py 100.00% <0.00%> (ø)
hub/api/tests/test_events.py 100.00% <0.00%> (ø)
hub/api/tests/test_pickle.py 100.00% <0.00%> (ø)
hub/core/storage/provider.py 100.00% <0.00%> (ø)
... and 51 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2893b40...4696b3f. Read the comment docs.

@tatevikh tatevikh merged commit 6dafa7b into main Mar 16, 2022
@tatevikh tatevikh deleted the istranic-readme-features-reformat branch March 16, 2022 14:54
@tatevikh tatevikh restored the istranic-readme-features-reformat branch March 16, 2022 16:30
@tatevikh tatevikh deleted the istranic-readme-features-reformat branch July 7, 2022 12:23
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.

3 participants