Skip to content

Make ASYNC manuals conform with man-pages(7) #10043

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.

Sign up for GitHub

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

Jump to bottom
Closed
levitte wants to merge 1 commit into from
Closed

Make ASYNC manuals conform with man-pages(7) #10043

levitte wants to merge 1 commit into from

Conversation

@levitte
Copy link
Member

@levitte levitte commented Sep 28, 2019

Details from man-pages(7) that are used:

 Formatting conventions for manual pages describing functions

     ...
     Variable names should, like argument names, be specified in italics.
     ...

 Formatting conventions (general)

     ...
     Special macros, which are usually in uppercase, are in bold.
     Exception: don't boldface NULL.
     ...

Additionally, expanded some lists to make better use of POD formatting.

Checklist
  • documentation is added or updated
  • tests are added or updated

@levitte
Make ASYNC manuals conform with man-pages(7)
3b328d5 
 Details from man-pages(7) that are used:

     Formatting conventions for manual pages describing functions

         ...
         Variable names should, like argument names, be specified in italics.
         ...

     Formatting conventions (general)

         ...
         Special macros, which are usually in uppercase, are in bold.
         Exception: don't boldface NULL.
         ...

Additionally, expanded some lists to make better use of POD formatting.
@levitte levitte added branch: master Applies to master branch issue: documentation The issue reports errors in (or missing) documentation labels Sep 28, 2019
@richsalz
Copy link
Contributor

richsalz commented Sep 28, 2019

Same comment as #10041 (comment)

Splitting this up was a bad idea.

@levitte
Copy link
Member Author

levitte commented Sep 28, 2019

This change has nothing to do with the things you say in #10041. Please look.

@richsalz
Copy link
Contributor

richsalz commented Sep 28, 2019

ENOCOFFEE. Sorry for the noise.

t8m
t8m approved these changes Sep 30, 2019
View reviewed changes
Copy link
Member

@t8m t8m left a comment

Choose a reason for hiding this comment

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

Nice work.

levitte added a commit that referenced this pull request Sep 30, 2019
@levitte
Make ASYNC manuals conform with man-pages(7)
dfe1752 
 Details from man-pages(7) that are used:

     Formatting conventions for manual pages describing functions

         ...
         Variable names should, like argument names, be specified in italics.
         ...

     Formatting conventions (general)

         ...
         Special macros, which are usually in uppercase, are in bold.
         Exception: don't boldface NULL.
         ...

Additionally, expanded some lists to make better use of POD formatting.

Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from #10043)
@levitte
Copy link
Member Author

levitte commented Sep 30, 2019

Merged. Thanks.

dfe1752 Make ASYNC manuals conform with man-pages(7)

@levitte levitte closed this Sep 30, 2019
@richsalz richsalz mentioned this pull request Oct 3, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@t8m t8m t8m approved these changes

Assignees

No one assigned

Labels

branch: master Applies to master branch issue: documentation The issue reports errors in (or missing) documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@levitte @richsalz @t8m