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

Improved Deque Documentation + docstrings #800

Merged
merged 2 commits into from
Apr 18, 2022

Conversation

lfenzo
Copy link
Contributor

@lfenzo lfenzo commented Apr 13, 2022

Hello!

This is the first of a series of PRs aiming to dramatically improve the current documentation of DataStructures.jl.

Some of the changes include the addition of actual documentation generated by Documenter.jl from docstrings (see docs/src/deque.md), a brief explanation of the Deque data structure and a few minor changes in source code.

The new documentation page formats will be structured in the following manner:

  1. Data structure description and characteristics.
  2. Constructors for the implemented data structure
  3. Usage, showing first a list of available methods for the given data structure sorted alphabetically, followed by the Documenter.jl generated documentation.

Let me know in case of any suggestions.

@StephenVavasis
Copy link
Contributor

Glad to hear you are doing this! Please note that #787 completely rewrites the documentation for the sorted containers. So if you are planning to work on those docs, it would be better to wait for 787 to get merged.

@lfenzo
Copy link
Contributor Author

lfenzo commented Apr 14, 2022

Hello @StephenVavasis

Thanks for letting me know! My plan is to rewrite the whole documentation (or as close to that as possible) automating everything with Documenter.jl, so I'll reach that one at some point.

Btw, nice work in #787.

Anyone available for reviewing this?

Copy link
Member

@oxinabox oxinabox left a comment

Choose a reason for hiding this comment

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

fantastic, thanks

@oxinabox oxinabox merged commit 98ad0f2 into JuliaCollections:master Apr 18, 2022
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.

3 participants