Self return type on from_dict methods

[janosh]

follow up to @DanielYang59's start in #3694 of adding Self return types on from_dict methods. far from complete. should be set on from_str and other from_... methods as well

[DanielYang59]

Great work 😄 ! I can take care of the rest if you don't mind.

Meanwhile I noticed at least two modules are using naming conventions as with_something instead of from_something, do we have any plan to unify their namings as well?

[janosh]

good catch. i think we can rename those to from_... with a year-long deprecation period.

[DanielYang59]

Sure. I would do that (I saw your follow up in monty but that deprecation decorator change is still not merged.). With that deprecation would much cleaner and easier.

[janosh]

while we're at it, these classes should be renamed to PascalCase (e.g. BrunnerNNReciprocal) and also be deprecated. you can find them with this regex: class [^(= ]+_[^(]+\(

[DanielYang59]

Sure would do.

Can you please rebuild the docs (should be quite outdated) as we changed quite a lot in #3694? 🌹

[janosh]

invoke make-doc doesn't do a whole lot. not sure how doc updating is supposed to work atm. @shyuep?

[DanielYang59]

Did you install sphinx dependencies (check warnings for invoke make-doc)? Like sphinx_markdown_builder and sphinx_rtd_theme? I got quite a lot of changes.

[janosh]

i did have those installed. i just updated sphinx_markdown_builder and sphinx_rtd_theme to v2 and ran again. that seems to have helped. still not many meaningful changes though. a few changed line ranges mostly af04258

[DanielYang59]

Great to know. Meanwhile I noticed this warning from 3 years ago #2149:

pymatgen/pymatgen/analysis/interface.py

Lines 18 to 23 in af04258

	warnings.warn(
	"The substrate_analyzer module is being moved to the interfaces submodule in analysis."
	" These imports will break in Pymatgen 2023",
	category=FutureWarning,
	stacklevel=2,
	)

I assume it might be old enough to be removed?