Skip to content

Apply updates for QNEthernet #11

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

Merged
merged 1 commit into from
Sep 19, 2024

Conversation

ssilverman
Copy link
Contributor

No description provided.

@ssilverman
Copy link
Contributor Author

ssilverman commented Sep 19, 2024

I'll note that there's this section in my README: Additional functions and features not in the Arduino-style API

Perhaps there's a place in your docs to mention that there's lots of extra features. Check out EthernetUDP::data(), for example. (It's mentioned in that Readme section.) See also the table of contents at the top for an overview of what's in that section.

@JAndrassy
Copy link
Member

Perhaps there's a place in your docs to mention that there's lots of extra features.

many libraries here have additional features. I focus on the common API

please make some changes in the PR:

  • for initCS I would prefer "init(CS)" in the cell. the note about SPI modules is not really necessary since init is optional, but if you want, make the note something like "(4) for SPI network module"
  • for maintain, please do only a + mark. In some other libraries maintain does nothing too.
  • 'modern' Server especially doesn't require to have Server/Print implemented. so please remove your note 5 there in the 'modern' column. if the Server in your library now has constructor without parameters, method begin(port), method end() and bool operator, you can add + mark in the 'modern' column

thank you

@ssilverman
Copy link
Contributor Author

ssilverman commented Sep 19, 2024

Perhaps there's a place in your docs to mention that there's lots of extra features.

many libraries here have additional features. I focus on the common API

please make some changes in the PR:

  • for initCS I would prefer "init(CS)" in the cell. the note about SPI modules is not really necessary since init is optional, but if you want, make the note something like "(4) for SPI network module"

I removed it because some drivers use it but others don't, and I don't want to imply that init(CS) is required if the driver doesn't need it.

  • for maintain, please do only a + mark. In some other libraries maintain does nothing too.

I used a check mark because maintain() has been there for a long time, before I was exposed to this project.

  • 'modern' Server especially doesn't require to have Server/Print implemented. so please remove your note 5 there in the 'modern' column. if the Server in your library now has constructor without parameters, method begin(port), method end() and bool operator, you can add + mark in the 'modern' column

Those functions have been there since before I was exposed to this project, so I'm going to use a check mark. I thought I hadn't satisfied the "modern" requirement because I have some things which the "modern" requirement says I shouldn't have. Perhaps rephrasing the following sentence would clarify that: "Modern implementations of the server class do not implement available() and print-to-all-clients so they don't inherit from Server." Here's a suggestion: "Some modern implementations of the server class still implement available() and print-to-all-clients, and also inherit from Server."

thank you

@ssilverman ssilverman changed the title Apply latest updates for QNEthernet Apply updates for QNEthernet Sep 19, 2024
@JAndrassy JAndrassy merged commit c010ca9 into Networking-for-Arduino:main Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants