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

rpicam-{hello,jpeg,raw,still,vid}: add page #12078

Merged
merged 47 commits into from
Jan 22, 2024
Merged

rpicam-{hello,jpeg,raw,still,vid}: add page #12078

merged 47 commits into from
Jan 22, 2024

Conversation

MIfoodie
Copy link
Contributor

  • 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):

The version of the command being documented is the latest version.

@github-actions github-actions bot added the new command Issues requesting creation of a new page. label Jan 15, 2024
@tldr-bot

This comment was marked as resolved.

@tldr-bot

This comment was marked as outdated.

Copy link
Member

@gutjuri gutjuri left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution, I have added some comments. However, we usually put pages for different commands into different files. I think that it would be better if you created one file for rpicam-hello, one for rpicam-jpeg and so on :)

pages/linux/rpicam.md Outdated Show resolved Hide resolved
pages/linux/rpicam.md Outdated Show resolved Hide resolved
pages/linux/rpicam.md Outdated Show resolved Hide resolved
pages/linux/rpicam.md Outdated Show resolved Hide resolved
pages/linux/rpicam.md Outdated Show resolved Hide resolved
@MIfoodie
Copy link
Contributor Author

MIfoodie commented Jan 16, 2024

Thanks for your contribution, I have added some comments. However, we usually put pages for different commands into different files. I think that it would be better if you created one file for rpicam-hello, one for rpicam-jpeg and so on :)

Ok sorry. First PR I was expecting there to be some problems :)

(I probably won't get to this tonight though it definitely will be completed by tomorrow)

@tldr-bot

This comment was marked as outdated.

@tldr-bot

This comment was marked as outdated.

@tldr-bot

This comment was marked as outdated.

@tldr-bot

This comment was marked as outdated.

@tldr-bot

This comment was marked as outdated.

@tldr-bot

This comment was marked as outdated.

@tldr-bot

This comment was marked as outdated.

@tldr-bot

This comment was marked as outdated.

@tldr-bot

This comment was marked as outdated.

@acuteenvy acuteenvy changed the title rpicam: add page rpicam-{hello,jpeg,raw,still,vid}: add page Jan 17, 2024
Copy link
Member

@vitorhcl vitorhcl left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution! I have suggested some changes:

  • If the value is already provided in the description, please don't use a placeholder, but rather leave it as part of the command. From the contributing guide:

However, if the description suggests a specific value, leave it as part of the command, and not as a placeholder, for example:

- Display records more recent than 3 days:

`lastlog --time 3`
  • Fix the path placeholder syntax. See the style guide:

Paths

  • Use {{filename}} when just the file name is expected.
  • For any reference to paths of files or directories,
    use the format {{path/to/<placeholder>}},
    except when the location is implicit.
  • When the path cannot be relative,
    but has to start at the root of the filesystem,
    prefix it with a slash,
    such as get {{/path/to/remote_file}}.
  • In case of a possible reference both to a file or a directory,
    use {{path/to/file_or_directory}}.

pages/linux/rpicam-hello.md Outdated Show resolved Hide resolved
pages/linux/rpicam-jpeg.md Outdated Show resolved Hide resolved
pages/linux/rpicam-jpeg.md Outdated Show resolved Hide resolved
pages/linux/rpicam-jpeg.md Outdated Show resolved Hide resolved
pages/linux/rpicam-raw.md Outdated Show resolved Hide resolved
pages/linux/rpicam-raw.md Outdated Show resolved Hide resolved
pages/linux/rpicam-still.md Outdated Show resolved Hide resolved
pages/linux/rpicam-still.md Outdated Show resolved Hide resolved
pages/linux/rpicam-vid.md Outdated Show resolved Hide resolved
pages/linux/rpicam-vid.md Outdated Show resolved Hide resolved
Copy link
Member

@gutjuri gutjuri left a comment

Choose a reason for hiding this comment

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

Thanks for incorporating my feedback!

Copy link
Contributor Author

@MIfoodie MIfoodie left a comment

Choose a reason for hiding this comment

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

Applied your changes except for one which I had to resolve...

Copy link
Member

@vitorhcl vitorhcl left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for your contribution!

pages/linux/rpicam-still.md Outdated Show resolved Hide resolved

- Capture a 100 second exposure image:

`rpicam-still -o name/of/file.jpg --shutter {{100000000}}`
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
`rpicam-still -o name/of/file.jpg --shutter {{100000000}}`
`rpicam-still -o name/of/file.jpg --shutter {{100000}}`

As far as I know, 100 seconds is 100000 milliseconds

pages/linux/rpicam-jpeg.md Outdated Show resolved Hide resolved
Copy link
Member

@kbdharun kbdharun left a comment

Choose a reason for hiding this comment

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

Welcome to tldr and thanks for your contribution.

LGTM, after @sebastiaanspeck's suggestions.

MIfoodie and others added 3 commits January 18, 2024 14:06
Co-authored-by: Sebastiaan Speck <[email protected]>
Co-authored-by: Sebastiaan Speck <[email protected]>
I probably need to go back to second grade math...
pages/linux/rpicam-vid.md Outdated Show resolved Hide resolved
pages/linux/rpicam-still.md Outdated Show resolved Hide resolved
Co-authored-by: Sebastiaan Speck <[email protected]>
@kbdharun kbdharun merged commit 59f2ba3 into tldr-pages:main Jan 22, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants