Available settings are undocumented

[cauebs]

As pointed out in #213, some settings are not yet documented.
I looked through the code and found these:

• settings.pypi.fallback - boolean - Always put PyPI last to prefere private repositories (defaults to true)
• settings.virtualenvs.create - boolean - Create a new virtualenv if one doesn't already exist (defaults to true?)
• settings.virtualenvs.in-project - boolean - Create the project's virtualenv inside the project's directory (defaults to false?)
• settings.virtualenvs.path - string - Directory where virtualenvs should be created (defaults to ~/.cache/pypoetry/virtualenvs?)
• repository.<name> - string - Additional repository's URL

Now, did I miss any? Are these defaults really the defaults? And where should it be documented? Here?

If we can agree on a way to present these informations, I'd be happy to work on a PR :)

[sdispater]

I think we can make a new documentation section, "Configuration", where we list the settings available with an example of how to set them.

Regarding settings.pypi.fallback, it actually configures the behavior of the resolver when it can't find the information it needs from the PyPI JSON API. If it's activated (the default) it will fallback to downloading and inspecting the package distributions (sdist or wheels) to find information about the package's dependencies. This was introduced early in development to make the resolution faster, albeit much less accurate, when the resolver was less efficient. However, I think we can remove it now that the resolver is much smarter and, to be completely honest, it's not that useful since deactivating it will make the resolver miss a lot of information.

[cauebs]

@sdispater I think tonight I'll start working on this section ;)

[cauebs]

Wouldn't it be interesting to add this list to the config command as well?

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.