Godot-docs: Connecting Signal - Outdated doc

[CitrusWire]

Godot 3.2.3

https://godot-es-docs.readthedocs.io/en/latest/getting_started/step_by_step/signals.html

That has a step-by-step guide for connecting a timer signal to a script.
THe blurb says:

Note that the Timer node is red - this is not an error, but is a visual indication that it’s the node that is emitting the signal.

And there's a screenshot that shows it too.

But for me it's not read, it's blue (which makes more sense from a "red is bad" perspective). The dialog is different too so I guess it has changed. I see:

(You're welcome to use that as the new screenie)

(I'd also suggest the "Advanced" tab should be closed in the screenshot too as that's the default).

[CitrusWire]

Other things that have changed:
1)
The big warning that says:

The target node must have a script attached or you’ll receive an error message.

Doesn't seem to be necessary either as it doesn't seem to be possible to select a node that doesn't have a script.

2)

On the bottom of the window is a field labeled “Method In Node”

is now "Receiver Method"

[pycbouh]

It says "blue" in the actual Godot Docs, both in stable (https://docs.godotengine.org/en/stable/getting_started/step_by_step/signals.html) and in latest (https://docs.godotengine.org/en/latest/getting_started/step_by_step/signals.html). This is some outdated mirror you're reading.

Same for "Receiver Method", but the warning has not been changed and may be actually outdated.

[CitrusWire]

Hmmm. Good point.

But then, Readthedocs (https://readthedocs.org/projects/godot/) says that:

This project contains the official documentation for the MIT-licensed Godot game engine.

And the actually-hosted-by-godot docs link to that "outdated mirror" (bottom left):
https://docs.godotengine.org/en/latest/

So... ? :-S

[pycbouh]

I don't see where it links to the host godot-es-docs.readthedocs.io. Official docs are available either via the RTD host godot.readthedocs.io or via our official domain docs.godotengine.org. And for Spanish version, for example, you can go to https://docs.godotengine.org/es/stable/ or pick the language in the bottom left panel.

This is the project you've been looking at: https://readthedocs.org/projects/godot-es-docs/. It is not maintained by the Godot team, it's this guy's mirror: https://readthedocs.org/profiles/quiro9/

[CitrusWire]

Yep, just looked at the URL, it is different, and the "es" in there would suggest it's Spanish, but it's actually English (I don't speak Spanish so that'd be a weird thing for me to reading :-) ).

I got to the docs through a search engine query. Now that I look, my docs tabs are a mixture of godotengine.org and the RTD link.

Looks like RTD have some weirdness going on at their end.

[pycbouh]

Yes, that mirror often appears in Google if you look for the docs. Not sure if we can or should do anything about it. Anybody is free to host a mirror of this documentation, as it's CC-BY-licensed. This particular one hasn't been updated for almost 2 years though.

[Calinou]

Has anyone managed to contact the owner of godot-es-docs? I can't find them on GitHub.

We have a more up-to-date Spanish translation in the official documentation now, so godot-es-docs should be taken down as to not confuse people.

[CitrusWire]

It's a variant of a problem I've come across before in other projects.

Search for something and get back a page for version 1.3, whereas the project is now on 2.4 or something. That's usually obvious because the URL has "1.3" in it rather than "latest" and "stable".

It's definitely something that falls under "should" do something about; otherwise you end up with situations like this which isn't useful for anyone. :-/

[pycbouh]

@Calinou Seeing as they don't even host their own fork but rather an outdated commit from the master Godot repo, I don't know if we can contact them in any form. Is there some PM system on RTD? That's the only account of theirs available. Might be worth messaging the RTD team instead.

[Calinou]

Is there some PM system on RTD?

I don't think there's one, just like on GitHub actually.

[CitrusWire]

https://docs.readthedocs.io/en/stable/contribute.html

Ask usage questions (“How do I?”) on StackOverflow.
Report bugs, suggest features or view the source code on GitHub.
Discuss topics on Gitter.
On IRC find us at #readthedocs.

(I tried their IRC, but it requires registering)

[pycbouh]

@CitrusWire Our docs are SEO'd to give stable the most priority, but you can personally open any URL with 3.2 in it instead. This problem here is different because that's a third-party mirror set up off of the back of this repo by an unknown person.

In case you are missing some crucial understanding here: both the official docs and this mirror are hosted by ReadTheDocs. Anyone can host any documentation on RTD. Godot docs just have a dedicated hostname in addition to the hostname provided by the RTD system. So the problem is not with RTD itself.

[CitrusWire]

@pycbouh - yeah, the outdated-versioning thing is not a problem I've seen with Godot, so excellent job there. :-)

I mentioned it as a variant because at its core it's an issue with search engines not really knowing what the definitive current version of a doc is. It's actually a difficult problem for a search engine to solve.

---

Thanks for the clarification. I'd come to that conclusion after your earlier helpful posts. Thanks.

[Calinou]

I sent an e-mail to Read the Docs about this situation.

[NathanLovato]

Should we close the issue? It's not a change we need to make to this repository, right?

[CitrusWire]

Well, this part is still the case with /latest/:

The big warning that says:

The target node must have a script attached or you’ll receive an error message.

Doesn't seem to be necessary either as it doesn't seem to be possible to select a node that doesn't have a script.

[NathanLovato]

Thanks, I'm on it.