simphony / docs

Documentation of the SimPhoNy Open Simulation Platform.
https://simphony.readthedocs.io
BSD 3-Clause "New" or "Revised" License
3 stars 4 forks source link

Review content to make sure it matches the latest versions #213

Closed pablo-de-andres closed 2 years ago

pablo-de-andres commented 2 years ago

@kysrpex I have done a general read and dealt with most of the warnings being shown in the build process. The remaining ones come from the api ref, so I do not think they should be tackled here (but in the actual docstrings). I briefly tried to silent them, but did not manage.

I would hand over to you now, ping me if you need anything

pablo-de-andres commented 2 years ago

Regarding black and isort, I run into some issues with pre-commit in another project, this is the configuration that worked in the end:


    - repo: https://github.com/psf/black
      rev: 22.3.0
      hooks:
          - id: black
            args:
                - --line-length=79

    - repo: https://github.com/pycqa/isort
      rev: 5.10.1
      hooks:
          - id: isort
            args:
                - --profile=black
                - --filter-files
                - --line-length=79

Leaving it here so we can apply it next week :)

pablo-de-andres commented 2 years ago

@kysrpex this has not been applied, has it?

Maybe we can just push the change to dev

kysrpex commented 2 years ago

@kysrpex this has not been applied, has it?

Maybe we can just push the change to dev

When you commented I was going to make a new PR, but it seems that it is already on dev.

pablo-de-andres commented 2 years ago

I seem to remember that syntax did not work as it should for me. That is why I suggested the alternative above.

kysrpex commented 2 years ago

I seem to remember that syntax did not work as it should for me. That is why I suggested the alternative above.

Then if you remember what was not working we make a PR. I do not remember :sweat_smile: .