Dario Quintero (Flexcompute)

This should be fixed in the pydantic v2 port

Haha sorry this is still WIP! I think the PR that was ready for review is https://github.com/flexcompute/tidy3d/pull/1451

So some of these issues might get solved by the tasks within the improve docs issues https://github.com/flexcompute/tidy3d/issues/1148, https://github.com/flexcompute/tidy3d-notebooks/issues/18 which I have pending. I agree with Tom's suggestion on the versioning...

So they are there so we can add extra documentation onto the parameters like the ones in the Simulation API https://docs.flexcompute.com/projects/tidy3d/en/latest/api/_autosummary/tidy3d.Simulation.html#tidy3d.Simulation.grid_spec Will be doing progressive improvements to the actual content...

- [ ] Fix this in the pydantic v2 port documentation upgrade https://github.com/flexcompute/tidy3d/issues/1213 - [ ] Implement this https://github.com/flexcompute/tidy3d/issues/1197 - [ ] https://github.com/flexcompute/tidy3d/issues/1374

One thing I'd like to propose is that we need to write the equations in latex before implementing them in python so that the user can visualise what's happening underneath...

Whoops sorry forgot this one existed, would have built onto this

I was looking further into your actual API documentation, and found that it should be [implemented already](https://autodoc-pydantic.readthedocs.io/en/latest/_modules/sphinxcontrib/autodoc_pydantic/inspection.html#ValidatorAdapter) ie from [source](https://autodoc-pydantic.readthedocs.io/en/latest/reference/api.html#sphinxcontrib.autodoc_pydantic.inspection.FieldInspector). I am looking into exactly the configuration

Hi @mansenfranzen thanks so much! I realised actually that we were using the pydantic-v1 interface layer underneath and that led to all the weird behaviour I was seeing. Looking forward...

Would this be more of a infrastructural/web issue worth putting in jira too?