Skip to content

Small docs change#384

Open
waynew wants to merge 3 commits into
aio-libs:masterfrom
waynew:main
Open

Small docs change#384
waynew wants to merge 3 commits into
aio-libs:masterfrom
waynew:main

Conversation

@waynew

@waynew waynew commented Oct 12, 2023

Copy link
Copy Markdown
Contributor

See #320 - I did a quick audit and changed the couple of things that could use it. I did not confirm whether or not any of the code samples in the docs have any changes that are inconsistent with the current codebase... My hope is that they were already update and tested 😅

Anyway... this may or may not completely resolve #320.

@waynew
waynew requested a review from pepoluan October 12, 2023 23:59

@pepoluan pepoluan left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A thot about that ... 🙃

Comment thread aiosmtpd/docs/intro.rst

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would split the piece of text explaining that we're replacement for smtpd into a separate paragraph, optionally with some kind of highlight / callout.

Comment thread aiosmtpd/docs/intro.rst Outdated
@webknjaz webknjaz closed this Jan 30, 2024
@webknjaz webknjaz reopened this Jan 30, 2024
@webknjaz

Copy link
Copy Markdown
Member

I enabled building PR previews @ RTD but it fails currently because the RTD config file needs to be updated: https://readthedocs.org/projects/aiosmtpd/builds/23289246/.

The GHA linting is failing is unrelated either, because of the unpinned flake8 plugin version, I suppose.

@webknjaz

Copy link
Copy Markdown
Member

the RTD config file needs to be updated

Filed an issue for this with pointers: #393.

waynew and others added 3 commits February 26, 2024 21:38
Rationale is an explantio, rational means "consistent with reason"
@codecov

codecov Bot commented Feb 26, 2024

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.12%. Comparing base (94710d8) to head (bb2d97f).
⚠️ Report is 123 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #384      +/-   ##
==========================================
- Coverage   98.14%   98.12%   -0.02%     
==========================================
  Files          22       22              
  Lines        5646     5646              
  Branches      755      755              
==========================================
- Hits         5541     5540       -1     
- Misses         68       70       +2     
+ Partials       37       36       -1     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@webknjaz

Copy link
Copy Markdown
Member

@waynew needs conflict resolution

@webknjaz
webknjaz enabled auto-merge (squash) May 7, 2026 14:02
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.

docs update for 1.5

3 participants