Skip to content
This repository has been archived by the owner on Feb 2, 2019. It is now read-only.

Bugs in doc examples #40

Open
hartwork opened this issue Mar 10, 2017 · 3 comments
Open

Bugs in doc examples #40

hartwork opened this issue Mar 10, 2017 · 3 comments

Comments

@hartwork
Copy link

Hi!

There seem to be two bugs in the examples.

First, this example right off the docs

> attr = AttrDict({'foo': [{'bar': 'baz'}, {'bar': 'qux'}]})
> for sub_attr in attr.foo:
>     print(subattr.foo)
'baz'
'qux'

gets me NameError: name 'subattr' is not defined because of the missing underscore in subattr but it's also foo a second time, while it would need to be bar, i.e. making print(sub_attr.bar) for the body of the loop.

Further down the docs read:

> adict = AttrDict({'list': [{'value': 1}, {'value': 2}]}, recursive=False)
> for element in adict.list:
>     isinstance(element, AttrDict)
False
False

But in ipython (with Python 2.7.13), I get this, instead:

In [29]: adict = AttrDict({'list': [{'value': 1}, {'value': 2}]}, recursive=False)

In [31]: [isinstance(element, AttrDict) for element in adict.list]
Out[31]: [True, True]  # ???

I am unsure if recursive=False is not working as expected or if just the example is broken. Please enlighten me. Thanks!

PS: The second example seems to also miss use of print(...) for the examples to be consistent to each other.

@e3krisztian
Copy link

See pull request #38

@hartwork
Copy link
Author

@e3krisztian, it still reads .foo in that commit. Can you fix that as well?

@e3krisztian
Copy link

e3krisztian commented Mar 11, 2017 via email

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants