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

advisory: document advisory command changes and few clean ups #920

Merged
merged 2 commits into from
Oct 17, 2023

Conversation

kontura
Copy link
Contributor

@kontura kontura commented Sep 27, 2023

Closes: #919

@pkratoch
Copy link
Contributor

Hi, the PR doesn't address this part of the issue: "dnf5 updateinfo --help does not provide any options while several options are listed in the man page". Do you plan to add it? Otherwise, the issue shouldn't be marked as closed by this.

@pkratoch
Copy link
Contributor

Also, I noticed that in the changes.rst document, single backticks are used everywhere to indicate command substitution, while for example in dnf5.8.rst, double backticks are used. When I build the documentation, the single backtics produce italics instead of literal, so if doesn't show e.g. options correctly. Is it the same for you or is there a special setting I am missing?

This changes the style from italics to literal making it more readable
and consistent with man pages.
@kontura
Copy link
Contributor Author

kontura commented Oct 17, 2023

Hi, the PR doesn't address this part of the issue: "dnf5 updateinfo --help does not provide any options while several options are listed in the man page". Do you plan to add it? Otherwise, the issue shouldn't be marked as closed by this.

That part was extracted into a separate issue: #921 which was closed in the mean time.

Also, I noticed that in the changes.rst document, single backticks are used everywhere to indicate command substitution, while for example in dnf5.8.rst, double backticks are used. When I build the documentation, the single backtics produce italics instead of literal, so if doesn't show e.g. options correctly. Is it the same for you or is there a special setting I am missing?

Yea, I am seeing the same. It is also here: https://dnf5.readthedocs.io/en/latest/changes.html. I added a commit to switch that to double backticks. What do you think?

@pkratoch
Copy link
Contributor

Hi, the PR doesn't address this part of the issue: "dnf5 updateinfo --help does not provide any options while several options are listed in the man page". Do you plan to add it? Otherwise, the issue shouldn't be marked as closed by this.

That part was extracted into a separate issue: #921 which was closed in the mean time.

I see, ok.

Also, I noticed that in the changes.rst document, single backticks are used everywhere to indicate command substitution, while for example in dnf5.8.rst, double backticks are used. When I build the documentation, the single backtics produce italics instead of literal, so if doesn't show e.g. options correctly. Is it the same for you or is there a special setting I am missing?

Yea, I am seeing the same. It is also here: https://dnf5.readthedocs.io/en/latest/changes.html. I added a commit to switch that to double backticks. What do you think?

Looks good, thanks.

@pkratoch pkratoch added this pull request to the merge queue Oct 17, 2023
Merged via the queue into rpm-software-management:main with commit 8e921b7 Oct 17, 2023
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

updateinfo issues
2 participants