refactored codebase a/c napoleon style

[RahulSankhla312]

Changed the whole codebase Refactored codebase to consistently use Napoleon-style docstrings.
Improves code readability and maintainability by providing clear function and class descriptions.

[RahulSankhla312]

@mr-tz @williballenthin I have made changes using the isort , for the code style.

[mr-tz]

please fix isort/black issues first

[RahulSankhla312]

Corrected the isort and black issues @mr-tz

[mr-tz]

code style looks good now, this will take a bit to go through

also other tests fail, need to look into those

[mr-tz]

Can you look into the test failures, please?

[RahulSankhla312]

@mr-tz Sure ill look into it.

[mr-tz]

Can you rebase this to master to (maybe) fix the test failures, please? Otherwise, we have to look closer at them.

[RahulSankhla312]

@mr-tz Sure i will take a look.

[mr-tz]

@RahulSankhla312 do you know what's failing here?

[mr-tz]

@RahulSankhla312 another ping, otherwise we may have to close this here

[Abhishekjc19]

name: CI

on:
push:
branches: [ master ]
pull_request:
branches: [ master ]

Save workspaces to speed up testing

env:
FLOSS_SAVE_WORKSPACE: "True"

jobs:
code_style:
runs-on: ubuntu-20.04
steps:
- name: Checkout FLOSS
uses: actions/checkout@v4.1.1
- name: Set up Python 3.8
uses: actions/setup-python@v5.0.0
with:
python-version: '3.8'
- name: Install dependencies
run: pip install -e .[dev]
- name: Lint with isort
run: pre-commit run isort --all-files
- name: Lint with black
run: pre-commit run black --all-files
- name: Check types with mypy
run: pre-commit run mypy --all-files

tests:
name: Tests in ${{ matrix.python-version }} on ${{ matrix.os }}
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-20.04, windows-2019, macos-11]
python-version: ['3.8', '3.9', '3.10', '3.11']
steps:
- name: Checkout FLOSS with submodules
uses: actions/checkout@v4.1.1
with:
submodules: true
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5.0.0
with:
python-version: ${{ matrix.python-version }}
- name: Install pyyaml (Ubuntu)
if: matrix.os == 'ubuntu-20.04'
run: sudo apt-get install -y libyaml-dev
- name: Install FLOSS
run: pip install -e .[dev]
- name: Run tests
run: pytest tests/

[mr-tz]

cc: @vee1e as we talked about doc improvements, just fyi

[vee1e]

yup, I think this can easily be made doxygen compatible by letting a good enough agent go through this.

[Abhishekjc19]

Hi maintainers, thanks for reviewing this PR.

I noticed there are merge conflicts with the latest master branch. I will resolve them and update the PR shortly.

Please let me know if you prefer this refactoring to be split into smaller PRs — happy to do that.

Looking forward to your feedback!

[vee1e]

@Abhishekjc19 are you making a new PR to resolve the conflicts? because @RahulSankhla312 is the author of this PR

[Abhishekjc19]

@Abhishekjc19 are you making a new PR to resolve the conflicts? because @RahulSankhla312 is the author of this PR

Thanks for pointing that out!

I’m not the author of this PR — I was just suggesting resolving the merge conflicts. The actual updates would need to be made by @RahulSankhla312.

Happy to help review or assist if needed.