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

Fix some rst warnings #2048

Merged
merged 1 commit into from Aug 21, 2017
Merged

Fix some rst warnings #2048

merged 1 commit into from Aug 21, 2017

Conversation

dforsi
Copy link
Contributor

@dforsi dforsi commented Jul 30, 2017

Thank you for your interest into contributing to OctoPrint, it's
highly appreciated!

Please make sure you have read the "guidelines for contributing" as
linked just above this form, there's a section on Pull Requests in there
as well that contains important information.

As a summary, please make sure you have ticked all points on this
checklist:

  • Your changes are not possible to do through a plugin and relevant
    to a large audience (ideally all users of OctoPrint)
  • If your changes are large or otherwise disruptive: You have
    made sure your changes don't interfere with current development by
    talking it through with the maintainers, e.g. through a
    Brainstorming ticket
  • Your PR targets OctoPrint's devel branch, or maintenance if it's
    a bug fix for an issue present in the current stable version (no PRs
    against master or anything else)
  • Your PR was opened from a custom branch on your repository
    (no PRs from your version of master, maintenance or devel please),
    e.g. dev/my_new_feature
  • Your PR only contains relevant changes: no unrelated files,
    no dead code, ideally only one commit - rebase your PR if necessary!
  • Your changes follow the existing coding style
  • If your changes include style sheets: You have modified the
    .less source files, not the .css files (those are generated with
    lessc)
  • You have tested your changes (please state how!) - ideally you
    have added unit tests
  • You have run the existing unit tests against your changes and
    nothing broke
  • You have added yourself to the AUTHORS.md file :)

Feel free to delete all this help text, then describe
your PR further. You may use the template provided below to do that.
The more details the better!


What does this PR do and why is it necessary?

This fixes two warnings, one that results in an user-visible change, the source of Listing 15 isn't visible in the locally built docs and it's caption shows the warning in the online docs at http://docs.octoprint.org/en/master/plugins/hooks.html#octoprint-comm-protocol-action

How was it tested? How can it be tested by the reviewer?

Comparing the HTML output.

Any background context you want to provide?

What are the relevant tickets if any?

Screenshots (if appropriate)

Before this fix
octoprint comm protocol action-before

After this fix
octoprint comm protocol action-after

Further notes

Replacing a single underscore (which creates a named target) with a double
underscore creates an anonymous target.

Fixes:
/home/daniele/OctoPrint/docs/bundledplugins/cura.rst:4: WARNING: Duplicate explicit target name: "here".
/home/daniele/OctoPrint/docs/plugins/hooks.rst:370: WARNING: Invalid caption: /home/daniele/OctoPrint/docs/plugins/hooks.rst:4: (INFO/1) Duplicate explicit target name: "custom_action_command.py".
@Kunsi
Copy link

Kunsi commented Jul 31, 2017

First of all, you should not create pull requests against master branch here, always create PRs against devel. Then, you should fix your PR overall, since it contains a lot of commits which are not related to your correction.

@dforsi dforsi changed the base branch from master to maintenance July 31, 2017 19:09
@dforsi
Copy link
Contributor Author

dforsi commented Jul 31, 2017

Thank you for your review.
I selected the wrong branch when creating this pull request, but in fact I branched off maintenance.

I think this is suitable for merging into maintenance because this is an error in the published developer's documentation, but I will rebase to devel if you think that this is error is too small for maintenance.

@Kunsi
Copy link

Kunsi commented Jul 31, 2017

Looks good from my side. However i'm not one of the maintainers of the project, so i'm not able to merge your changes. I'm just some user trying to take some load off the maintainers.

@foosel foosel merged commit 7828258 into OctoPrint:maintenance Aug 21, 2017
@foosel
Copy link
Member

foosel commented Aug 21, 2017

I'm on the other hand am one of the maintainers, just came back from my vacation and am very thankful for this PR :)

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 28, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants