conan-io / conan-io/docs

[question] Possible mistake (or need for clarification) in documentation (section fetching sources from external repos)

Open
#2,366 1 comment 0 reactions 1 assignee Claimed by @memsharded View on GitHub
Dominant language
C++
Stars
125
Forks
382
Avg merge
22h 39m
Merged PRs (30d)
21

Description

I was following the documentation, when I was thrown off by a reference to a supposed explanation in the 'previous section' that doesn't seem to exist:

https://docs.conan.io/en/latest/creating_packages/external_repo.html

"_There are two different ways to fetch the sources from an external repository:
Using the source() method as we displayed in the previous section: [...]_"

I personally would read this sentence as "_There are two ways to fetch sources from an external repository, one of those is the source() method, we already displayed the source() method in the previous section_".
However no reference to a source() method seems to exist in the previous section, and no line containing `def source(self):` exists in conanfile.py.

For this reason I believe the sentence was maybe intended to be read as "_There are two ways to fetch sources from an external repository, one of those is the source() method. In the previous section we displayed the conanfile.py recipe, which we will now modify like this: [...]_"
An alternative explanation that I could think of is that source() really was displayed in the previous section of the documentation at some point, but this part got either removed or moved elsewhere, but the reference to the previous section remained.

Or did I accidentally skip over something or am misreading this sentence horribly?

- [x] I've read the [CONTRIBUTING guide](https://github.com/conan-io/conan/blob/develop/.github/CONTRIBUTING.md).

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.