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

Fix docs context-free commands subsection #969

Merged

Conversation

cih9088
Copy link
Contributor

@cih9088 cih9088 commented Apr 20, 2023

Summary

  • Aligned docs
  • Changed to console format

How to test

Checklist

  • I have added unit tests to cover my changes.​
  • I have added integration tests to cover my changes.​
  • I have added the description of my changes into CHANGELOG.​
  • I have updated the documentation accordingly

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.
  • I have updated the license header for each file (see an example below).
# Copyright (C) 2023 Intel Corporation
#
# SPDX-License-Identifier: MIT

Signed-off-by: Inhyuk Andy Cho <andy.inhyuk.jo@intel.com>
Signed-off-by: Inhyuk Andy Cho <andy.inhyuk.jo@intel.com>
Signed-off-by: Inhyuk Andy Cho <andy.inhyuk.jo@intel.com>
Signed-off-by: Inhyuk Andy Cho <andy.inhyuk.jo@intel.com>
Signed-off-by: Inhyuk Andy Cho <andy.inhyuk.jo@intel.com>
Signed-off-by: Inhyuk Andy Cho <andy.inhyuk.jo@intel.com>
Signed-off-by: Inhyuk Andy Cho <andy.inhyuk.jo@intel.com>
Signed-off-by: Inhyuk Andy Cho <andy.inhyuk.jo@intel.com>
Signed-off-by: Inhyuk Andy Cho <andy.inhyuk.jo@intel.com>
Signed-off-by: Inhyuk Andy Cho <andy.inhyuk.jo@intel.com>
Signed-off-by: Inhyuk Andy Cho <andy.inhyuk.jo@intel.com>
Signed-off-by: Inhyuk Andy Cho <andy.inhyuk.jo@intel.com>
Signed-off-by: Inhyuk Andy Cho <andy.inhyuk.jo@intel.com>
Signed-off-by: Inhyuk Andy Cho <andy.inhyuk.jo@intel.com>
Signed-off-by: Inhyuk Andy Cho <andy.inhyuk.jo@intel.com>
Signed-off-by: Inhyuk Andy Cho <andy.inhyuk.jo@intel.com>
@cih9088 cih9088 added the DOC Improvements or additions to documentation label Apr 20, 2023
@cih9088 cih9088 added this to the 1.2.0 milestone Apr 20, 2023
@cih9088 cih9088 requested review from a team as code owners April 20, 2023 07:14
Signed-off-by: Inhyuk Andy Cho <andy.inhyuk.jo@intel.com>
Copy link
Contributor

@vinnamkim vinnamkim left a comment

Choose a reason for hiding this comment

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

I don't think that it is good idea to change .py when the release is super close. It would be good to leave documentation changes here and the other things should be targeted to develop.

datumaro/cli/commands/diff.py Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

Codecov Report

Patch coverage has no change and project coverage change: -0.03 ⚠️

Comparison is base (45d3f80) 78.71% compared to head (4eaf3c1) 78.69%.

❗ Current head 4eaf3c1 differs from pull request most recent head c18179e. Consider uploading reports for the commit c18179e to get more accurate results

Additional details and impacted files
@@                Coverage Diff                 @@
##           releases/1.2.0     #969      +/-   ##
==================================================
- Coverage           78.71%   78.69%   -0.03%     
==================================================
  Files                 231      231              
  Lines               26420    26420              
  Branches             5258     5258              
==================================================
- Hits                20796    20790       -6     
- Misses               4400     4402       +2     
- Partials             1224     1228       +4     
Flag Coverage Δ
macos-11_Python-3.8 ?
ubuntu-20.04_Python-3.8 78.69% <0.00%> (-0.01%) ⬇️
windows-2019_Python-3.8 ?

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

Impacted Files Coverage Δ
datumaro/cli/commands/convert.py 22.03% <ø> (ø)
datumaro/cli/commands/detect_format.py 21.42% <0.00%> (ø)
datumaro/cli/commands/diff.py 20.95% <0.00%> (ø)
datumaro/cli/commands/download.py 17.85% <ø> (ø)
datumaro/cli/commands/explain.py 14.13% <ø> (ø)
datumaro/cli/commands/explore.py 27.27% <ø> (ø)
datumaro/cli/commands/filter.py 20.00% <ø> (ø)
datumaro/cli/commands/generate.py 34.37% <ø> (ø)
datumaro/cli/commands/info.py 17.24% <ø> (ø)
datumaro/cli/commands/merge.py 21.17% <ø> (ø)
... and 4 more

... and 3 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@@ -9,7 +9,7 @@ The detection result may be one of:

- a single format being detected;
- no formats being detected (if the dataset doesn't match any known format);
- multiple formats being detected (if the dataset is ambiguous).
- multiple formats being detected (if the dataset is ambiguous);
Copy link
Contributor

Choose a reason for hiding this comment

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

. seems correct, is it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agreed. Fixed in bcc7a4d

docs/source/docs/command-reference/context_free/diff.md Outdated Show resolved Hide resolved
(`?` is used for optional parts)

```console
datum merge <path/to/project1/> <path/to/project2/> <path/to/project3/> <path/toproject4/> \
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
datum merge <path/to/project1/> <path/to/project2/> <path/to/project3/> <path/toproject4/> \
datum merge <path/to/project1/> <path/to/project2/> <path/to/project3/> <path/to/project4/> \

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed in bcc7a4d

cih9088 and others added 2 commits April 20, 2023 17:12
Co-authored-by: Vinnam Kim <vinnam.kim@gmail.com>
Co-authored-by: Vinnam Kim <vinnam.kim@gmail.com>
Copy link
Contributor

@vinnamkim vinnamkim left a comment

Choose a reason for hiding this comment

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

LGTM.

@vinnamkim vinnamkim mentioned this pull request Apr 20, 2023
6 tasks
@vinnamkim vinnamkim merged commit 576d779 into openvinotoolkit:releases/1.2.0 Apr 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DOC Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants