Fix a crate doc link for IterNextOutput

[cfour2]

This should fix the links 1 and 2.

They originally point to, which do not exist now:

1. https://docs.rs/pyo3/0.18.3/pyo3/pyclass/trait.PyIterProtocol.html
2. https://docs.rs/pyo3/0.18.3/pyo3/class/iter/enum.IterNextOutput.html

[DataTriny]

First time contributor has agreed to the new licensing scheme.

[adamreichold]

I am not sure if the code example in the linked module-level documentation is really sufficient. I guess the best documentation on this we currently have is https://pyo3.rs/v0.18.3/class/protocols#iterable-objects but that is not part of the inline documentation.

Would you be up to replacing the link by a dedicated example on how to use IterNextOutput

You can find the old example referenced here at https://github.com/PyO3/pyo3/blob/f4724dc1aa522d57f91401ef4842d8ed1e9bd546/src/class/iter.rs

[cfour2]

Hi @adamreichold ,

The old example seems moved here:
https://github.com/PyO3/pyo3/blob/main/pytests/src/pyclasses.rs#L15-L36

Do you prefer replacing the link by a dedicated example or just pointing it to the pytests code above?

[adamreichold]

An inline example (even if it starts as a copy of the test) would definitely be helpful as it can be viewed without leaving the inline documentation (which for example is also available offline).

[adamreichold]

I fear the CI is also broken independently of this change request. I will try to fix this separately...

[cfour2]

The example is copied together with some comments. It should look like this here:

use pyo3::prelude::*;
use pyo3::iter::IterNextOutput;

#[pyclass]
struct PyClassIter {
    count: usize,
}

#[pymethods]
impl PyClassIter {
    #[new]
    pub fn new() -> Self {
        PyClassIter { count: 0 }
    }

    fn __next__(&mut self) -> IterNextOutput<usize, &'static str> {
        if self.count < 5 {
            self.count += 1;
            // Given an instance `counter`, First five `next(counter)` calls yield 1, 2, 3, 4, 5.
            IterNextOutput::Yield(self.count)
        } else {
            // At the sixth time, we get a `StopIteration` with `'Ended'`.
            //     try:
            //         next(counter)
            //     except StopIteration as e:
            //         assert e.value == 'Ended'
            IterNextOutput::Return("Ended")
        }
    }
}

And good luck with the CI...

[adamreichold]

And good luck with the CI...

The CI should be fixed now. I you remove the link, consent to the license change, fix the formatting and rebase onto the main branch, this should be good to go.

[cfour2]

Thanks for the help and patience! All issues mentioned above are now resolved.

• doc
  • Remove the (eventually) stale link;
  • Fix the typo: couter -> counter;
  • cargo fmt;
• consent to the license change;
• rebase onto the main branch;
• CI;

[adamreichold]

Thank you for going the extra mile and helping us to improve the documentation!

bors r+

[bors]

Build succeeded!

The publicly hosted instance of bors-ng is deprecated and will go away soon.

If you want to self-host your own instance, instructions are here.
For more help, visit the forum.

If you want to switch to GitHub's built-in merge queue, visit their help page.

• conclusion