[issue33860] doc Avoid "ordered dictionary" references now that dictionaries are ordered

2018-06-15 Thread Ethan Furman
Ethan Furman added the comment: As I said on the PR: This feels like an unnecessary change. The phrase "ordered dictionary" does not always refer to an 'OrderedDict`, and there is more than one way to order a dictionary besides insertion order. As a side note: it's generally better to have

[issue33860] doc Avoid "ordered dictionary" references now that dictionaries are ordered

2018-06-14 Thread Andrés Delfino
Andrés Delfino added the comment: Perhaps we can continue the discussion on #33863 as there are more argumnets there, from all points of view, and when a decision is taken there, we can apply it here too. -- ___ Python tracker

[issue33860] doc Avoid "ordered dictionary" references now that dictionaries are ordered

2018-06-14 Thread INADA Naoki
INADA Naoki added the comment: > Please note that DictReader already mentions "OrderedDict" as a type it > returns now. OK, but PR-7535 changes enum too. > but "dictionary" alone doesn't seem like a good weak name to me, as it's the > common name of an actual type. As I commented in

[issue33860] doc Avoid "ordered dictionary" references now that dictionaries are ordered

2018-06-14 Thread Andrés Delfino
Andrés Delfino added the comment: I believe the discussion in #33863 is relevant. Depending on what the API the user can rely on, perhaps "an ordered mapping" fits here too. -- ___ Python tracker

[issue33860] doc Avoid "ordered dictionary" references now that dictionaries are ordered

2018-06-14 Thread Andrés Delfino
Andrés Delfino added the comment: Please note that DictReader already mentions "OrderedDict" as a type it returns now. I do see the issue you raise though and I'm not proposing to guarantee that type for next versions. I see the benefits of using weak names, but "dictionary" alone doesn't

[issue33860] doc Avoid "ordered dictionary" references now that dictionaries are ordered

2018-06-14 Thread INADA Naoki
INADA Naoki added the comment: Sometime, we chose weak name like "file-like" or "dictionary" over "io.TextIOWrapper" or "dict", to avoid making future improvements harder. If there are no strong reason to specify concrete type, let's keep using weak name. In case of enum members, I want to

[issue33860] doc Avoid "ordered dictionary" references now that dictionaries are ordered

2018-06-14 Thread INADA Naoki
INADA Naoki added the comment: "ordered dictionary" means "dict-like object which preserves insertion order". Both of dict and OrderedDict is "ordered dictionary". If we change it to OrderedDict, it make harder to change return type from OrderedDict to normal dict. Do you propose we

[issue33860] doc Avoid "ordered dictionary" references now that dictionaries are ordered

2018-06-14 Thread Andrés Delfino
New submission from Andrés Delfino : IMHO, using "ordered dictionaries" references is somewhat confusing now that dictionaries preserve insertion order. PR changes this references to "OrderedDict object". -- assignee: docs@python components: Documentation messages: 319523 nosy: