Skip to content

Conversation

@damianut
Copy link
Contributor

@damianut damianut commented Oct 9, 2024

@muczc1wek
Copy link
Contributor

Do we need this "otherwise in ..." at all?

@Patrix9999
Copy link

Do we need this "otherwise in ..." at all?

Good question, this only covers one edge case (when encoding page that is being used is outside of scope of supported encodings).

@kamilkrzyskow
Copy link
Collaborator

kamilkrzyskow commented Oct 12, 2024

As I said before, the docs should strive for factuality, so the change in the PR is good. EDIT: But the "otherwise" word doesn't really convey the "if the language is not supported then it will default to German"

this only covers one edge case (when encoding page that is being used is outside of scope of supported encodings).

The question is now, would adding more of such remarks "bloat" the docs? How much of such remarks are missing?
I always thought that the more source code is explained in the docs the better, but I saw this video recently, from which I got that, only "general ideas" should be documented and not the code.

https://www.youtube.com/watch?v=Y6ZHV0RH0fQ

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.

4 participants