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

arecord, convert: edit pages #12644

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

TheFibonacciEffect
Copy link

@TheFibonacciEffect TheFibonacciEffect commented Apr 14, 2024

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page(s) have at most 8 examples.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known):

@CLAassistant
Copy link

CLAassistant commented Apr 14, 2024

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the page edit Changes to an existing page(s). label Apr 14, 2024
@tldr-bot
Copy link

The build for this PR failed with the following error(s):

pages/common/convert.md:15: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/convert.md:16: TLDR007 Example descriptions should be surrounded by empty lines
pages/common/convert.md:0: TLDR019 Page should only include a maximum of 8 examples
pages/linux/arecord.md:
Error: Parse error on line 26:
...ord --interactive``test your microphon
---------------------^
Expecting 'TEXT', 'DASH', got 'BACKTICK'

Please fix the error(s) and push again.

@tldr-bot
Copy link

The build for this PR failed with the following error(s):

pages/common/convert.md:15: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/convert.md:16: TLDR007 Example descriptions should be surrounded by empty lines
pages/linux/arecord.md:
Error: Parse error on line 26:
...ord --interactive``test your microphon
---------------------^
Expecting 'TEXT', 'DASH', got 'BACKTICK'

Please fix the error(s) and push again.

@tldr-bot
Copy link

The build for this PR failed with the following error(s):

pages/common/convert.md:15: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/convert.md:16: TLDR007 Example descriptions should be surrounded by empty lines
pages/linux/arecord.md:26: TLDR102 Example description probably not properly annotated
pages/linux/arecord.md:27: TLDR007 Example descriptions should be surrounded by empty lines

Please fix the error(s) and push again.

@gutjuri gutjuri changed the title add command to resize to desired size and add command to test microphone arecord, convert: edit pages Apr 14, 2024
@tldr-bot
Copy link

The build for this PR failed with the following error(s):

pages/common/convert.md:15: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/convert.md:16: TLDR007 Example descriptions should be surrounded by empty lines
pages/linux/arecord.md:26: TLDR005 Example descriptions should end in a colon with no trailing characters

Please fix the error(s) and push again.

@tldr-bot
Copy link

The build for this PR failed with the following error(s):

pages/common/convert.md:15: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/convert.md:16: TLDR007 Example descriptions should be surrounded by empty lines

Please fix the error(s) and push again.

@TheFibonacciEffect
Copy link
Author

TheFibonacciEffect commented Apr 14, 2024

Allright now its ready : )
These commands are very useful to me and I hope they are to others as well, sorry that it took me several tries with the formatting...

pages/common/convert.md Outdated Show resolved Hide resolved

`convert {{path/to/image1.png path/to/image2.png ...}} +append {{path/to/output_image.png}}`
`convert {{path/to/input_image.png}} -define jpeg:extent=512kb {{path/to/output_image.jpg}}`

- Vertically append images:
Copy link
Member

Choose a reason for hiding this comment

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

Maybe change this example to include the horizontally append as well?

Copy link
Author

Choose a reason for hiding this comment

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

I think if we keep both horizontal and vertical append examples we will have more than 6 examples, so I chose to remove that one, because its similar to horizontal append. But we can also make some other choice.

Copy link
Member

Choose a reason for hiding this comment

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

I meant to merge the two examples into one:

convert ... -append/+append ...

Copy link
Author

Choose a reason for hiding this comment

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

Ah that makes sense, Ill add it

Comment on lines 26 to 28
- Test your microphone:

`arecord -d 5 test-mic.wav && aplay test-mic.wav && rm test-mic.wav`
Copy link
Member

Choose a reason for hiding this comment

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

This describes a use case for arecord/aplay, I am not sure if we want this included in the tldr-page? @kbdharun @vitorhcl

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, we can document only the example relevant to this page and not aplay IMO.

Copy link
Author

Choose a reason for hiding this comment

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

I kind of feel like arecord and aplay belong together but if you want to have it sepeately, thats okay too.

Copy link
Member

Choose a reason for hiding this comment

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

This describes a use case for arecord/aplay, I am not sure if we want this included in the tldr-page? @kbdharun @vitorhcl

Sorry for the delay, I didn't saw your comment. I have a different opinion than @kbdharun.

There are pages that mix some commands, so it's fine to describe a use case for both two commands, as long as one of them is the main one.

It's more about the perspective itself: this command is mainly using aplay or arecord, i.e., is the core behavior recording the microphone or playing the microphone audio? IMO it's roughly 50%, so we can keep it.

Copy link
Member

Choose a reason for hiding this comment

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

However, IMO it is important to document how to record to a file too.

Copy link
Author

Choose a reason for hiding this comment

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

I think its clear that the first command records a file.

Comment on lines 26 to 28
- Test your microphone:

`arecord -d 5 test-mic.wav && aplay test-mic.wav && rm test-mic.wav`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Test your microphone:
`arecord -d 5 test-mic.wav && aplay test-mic.wav && rm test-mic.wav`
- Record 5 seconds of mic audio:
`arecord -d 5 {{path/to/output_audio.mp3}}`

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Test your microphone:
`arecord -d 5 test-mic.wav && aplay test-mic.wav && rm test-mic.wav`
- Record 5 seconds of mic audio:
`arecord --duration 5 {{path/to/output_audio.mp3}}`

@TheFibonacciEffect
Copy link
Author

Is there anything that needs to be fixed before merging?

@@ -16,13 +16,13 @@

`convert {{path/to/input_image.png}} -resize 640x480 {{path/to/output_image.png}}`

- Horizontally append images:
- Scale an image to have a specified filesize:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Scale an image to have a specified filesize:
- Scale an image to have a specified file size:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
page edit Changes to an existing page(s).
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants