Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix doc generation errors and re-organize examples #914

Merged
merged 4 commits into from
May 26, 2022

Conversation

dhoomakethu
Copy link
Contributor

No description provided.

@janiversen janiversen force-pushed the example-docs-updates branch from 7da0a0f to bbc46e0 Compare May 26, 2022 06:12
@janiversen
Copy link
Collaborator

I have updated your PR, because a lot of the changes was already done.

I have no problem moving the examples back, but then they should be changed to be asyncio only. Please do not forget the idea to move them in the first place, was to get rid of twisted/tornado.

Why is it important to have e.g. examples/contrib/tornado_twisted/sunspec_client.py direct in examples ?

A compromise could be to let the documentation point at the tornado_twisted directory.

@dhoomakethu
Copy link
Contributor Author

dhoomakethu commented May 26, 2022

sunspec client I did not check but I was moving the synchronous and updating server examples which are based on synchronous server (socketserver). I am OK with keeping only twisted and tornado examples separate and the same time lets also try to keep the .py extension as it is till we completly get rid off them.

UPDATE
sunspec client is still with in the contrib/tornado_twisted directory ? what are we discussing here ?

@janiversen
Copy link
Collaborator

Now the doc can be generated here (after a rebase and an extra commit).

I will take a closer look now at the files you moved.

Sunspec was my bad, I was confused by something else.

@janiversen
Copy link
Collaborator

  • synchronous_server.pyX
    Was already moved on dev.
  • updating_server.pyX and dbstore_update_server.pyX
    uses twisted, see line 16
from twisted.internet.task import LoopingCall

Now I can see that there are missing rst files, let me update that.

@janiversen
Copy link
Collaborator

@dhoomakethu Please exclude the examples directory from Sonar, or at the very least remove the check for duplicate code (which is quite normal between examples).

@janiversen janiversen force-pushed the example-docs-updates branch from f288f63 to 00deda8 Compare May 26, 2022 10:54
@sonarcloud
Copy link

sonarcloud bot commented May 26, 2022

SonarCloud Quality Gate failed.    Quality Gate failed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 54 Code Smells

No Coverage information No Coverage information
9.3% 9.3% Duplication

@janiversen janiversen merged commit 62cb941 into dev May 26, 2022
@janiversen janiversen deleted the example-docs-updates branch May 26, 2022 11:09
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 21, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants