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

Update scopes.md #704

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update scopes.md #704

wants to merge 1 commit into from

Conversation

tpinfold
Copy link
Contributor

#694

Thank you for taking the time to help the darktable documentation!

Please include a link to the Pull Request that you are documenting

darktable-org/darktable#17838

Tell us a little bit about this pull request

Have just implemented developers description and confirmed it functions as described.

@@ -111,15 +111,21 @@ Bear in mind that these controls are provided as a basic guide to achieving colo

# exposure adjustment

The histogram, waveform, and RGB parade scopes can be used to directly alter the _exposure_ and _black level_ of the [_exposure_](../../processing-modules/exposure.md) module.
The histogram, waveform, and RGB parade scopes can be used to directly alter the exposure and black level of the exposure module.
Copy link
Contributor

Choose a reason for hiding this comment

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

In other places in the docs, individual controls (like exposure and black level here) are highlighted using italics.
Also, why remove the link to the exposure module's docs?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for looking at this @kofa73. This is my first attempt at learning how to help with documentation. I just copied what was already in the user manual and added the bare minimum to update the documentation to be correct. I didn't mean to remove any links or change the use of italics, but I see the inconsistency in the use of italics in the document I copied from. Can you advice how I retain the link? I am still on my L plates here.

Copy link
Contributor

Choose a reason for hiding this comment

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

The site uses markdown format, which is pretty simple, and the same as github uses for its comments. Github provides a guide (here) or there are various "cheat sheets" available (for example here)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should I rewrite my correction or is this close enough to be edited and used?

Copy link
Contributor

Choose a reason for hiding this comment

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

Just restore the original text:

Suggested change
The histogram, waveform, and RGB parade scopes can be used to directly alter the exposure and black level of the exposure module.
The histogram, waveform, and RGB parade scopes can be used to directly alter the _exposure_ and _black level_ of the [_exposure_](../../processing-modules/exposure.md) module.

Copy link
Contributor

Choose a reason for hiding this comment

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

If this PR is a one-off I don't mind making edits when I get around to merging, but if you intend to submit more pull requests in the future it would be good to learn the process for making changes.

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.

3 participants