Skip to content

Commit

Permalink
no longer pull in documentation of IO methods from Base
Browse files Browse the repository at this point in the history
Pulling in the entire documentation of also applicable `IO` methods
was a bad idea, as that created ever more unresolved references to
other methods. Therefore, just list the names of these methods
instead.
  • Loading branch information
mgkuhn committed Jul 27, 2022
1 parent 2f18eda commit 231d738
Showing 1 changed file with 2 additions and 17 deletions.
19 changes: 2 additions & 17 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,9 @@ sp_output_waiting

Many of the read/write methods defined in `Base` that operate on an
object of type `IO` can also be used with objects of type
`SerialPort`. Therefore we repeat the documentation of some of these
here. (Note that some of the following docstings also refer to other
methods that are not applicable to `SerialPort`.)
`SerialPort`. Therefore, also consult the documentation for

```@docs
```
Base.read(::IO, ::Any)
Base.read!
Base.readbytes!
Expand All @@ -64,16 +62,3 @@ read(::SerialPort)
nonblocking_read(::SerialPort)
bytesavailable(::SerialPort)
```

# Other references

The following are listed here only because they are referenced above:

```@docs
Base.ntoh
Base.hton
Base.ltoh
Base.htol
Base.stdout
Base.string(xs...)
```

0 comments on commit 231d738

Please sign in to comment.