Avoid importing namespace package pymatgen directly

[DanielYang59]

Summary

• Avoid importing namespace package pymatgen directly
• [Question] Should we recommend the following alias (I thought pmg would be a shorthand of pymatgen instead of pymatgen.core):

  pymatgen/docs/index.md

  Line 181 in 15dc137

  import pymatgen.core as pmg

[janosh]

[Question] Should we recommend the following alias (I thought pmg would be a shorthand of pymatgen instead of pymatgen.core):

no strong opinion but leaning towards not proliferating that usage

[DanielYang59]

[Question] Should we recommend the following alias (I thought pmg would be a shorthand of pymatgen instead of pymatgen.core):

no strong opinion but leaning towards not proliferating that usage

Okay thanks for your reply, we might just from pymatgen.core import xxx (not the wild card *) then. And we might need to rebuild docs again (perhaps add rebuilding docs as an automate workflow as well?).

[janosh]

perhaps add rebuilding docs as an automate workflow as well?

yes, that should have been done a long time ago. in particular, there's no reason to keep the generated HTML for docs under version control. it's a major history pollutant

[DanielYang59]

perhaps add rebuilding docs as an automate workflow as well?

yes, that should have been done a long time ago.

Okay I would have a look at this if you don't have much time ATM :)

in particular, there's no reason to keep the generated HTML for docs under version control. it's a major history pollutant

Yes!