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

refactor(docs): move from reST to Markdown #145

Merged
merged 2 commits into from
Aug 29, 2024

Conversation

tiborsimko
Copy link
Member

  • refactor(docs): move from reST to Markdown

    Converts docs from reStructuredText to Markdown so that the changelog
    file is compatible with Release Please.

  • ci(run-tests): stop properly after running all tests

    Fixes run-tests.sh to stop properly after running all tests in a
    situation when no command-line arguments were passed by the developer.

Copy link

codecov bot commented Aug 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.65%. Comparing base (bac8200) to head (357a719).
Report is 2 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #145   +/-   ##
=======================================
  Coverage   80.65%   80.65%           
=======================================
  Files          12       12           
  Lines         729      729           
=======================================
  Hits          588      588           
  Misses        141      141           

@tiborsimko tiborsimko requested a review from mdonadoni August 26, 2024 09:27
tiborsimko added a commit to tiborsimko/cernopendata-client that referenced this pull request Aug 26, 2024
Converts docs from reStructuredText to Markdown so that the changelog
file is compatible with Release Please.
tiborsimko added a commit to tiborsimko/cernopendata-client that referenced this pull request Aug 26, 2024
Fixes `run-tests.sh` to stop properly after running all tests in a
situation when no command-line arguments were passed by the developer.
docs/usage.md Outdated
## More information

For more information about all the available `cernopendata-client`
commands and options, please see `cliapi`{.interpreted-text role="ref"}.
Copy link
Member

Choose a reason for hiding this comment

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

It seems like interpreted-text role="ref" is not being interpreted properly, here and elsewhere.

Before
image

After
image

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks, fixed both places.

Converts docs from reStructuredText to Markdown so that the changelog
file is compatible with Release Please.
Fixes `run-tests.sh` to stop properly after running all tests in a
situation when no command-line arguments were passed by the developer.
@tiborsimko tiborsimko merged commit 357a719 into cernopendata:master Aug 29, 2024
17 checks passed
@tiborsimko tiborsimko deleted the markdown-docs branch August 29, 2024 08:33
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.

2 participants