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

Small docs change #384

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Small docs change #384

wants to merge 3 commits into from

Conversation

waynew
Copy link
Collaborator

@waynew waynew commented Oct 12, 2023

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
Copy link
Collaborator

@pepoluan pepoluan left a comment

Choose a reason for hiding this comment

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

A thot about that ... 🙃

Copy link
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.

aiosmtpd/docs/intro.rst Outdated Show resolved Hide resolved
@webknjaz webknjaz closed this Jan 30, 2024
@webknjaz webknjaz reopened this Jan 30, 2024
@webknjaz
Copy link
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
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"
Copy link

codecov bot commented Feb 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.12%. Comparing base (94710d8) to head (bb2d97f).
Report is 10 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 Sentry.
📢 Have feedback on the report? Share it here.

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