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.

Sign up for GitHub

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

Jump to bottom

[Docs] Add contents to the docs #21

Merged
merged 28 commits into from
Dec 9, 2024
Merged

[Docs] Add contents to the docs #21

merged 28 commits into from
Dec 9, 2024

Conversation

pimvenderbosch
Copy link
Member

@pimvenderbosch pimvenderbosch commented Nov 29, 2024 •
edited
Loading

In this PR the contents of the documentation pages will be filled.

  • Improve docstrings
  • Write general documentation pages

@pimvenderbosch pimvenderbosch added the documentation Improvements or additions to documentation label Nov 29, 2024
@pimvenderbosch pimvenderbosch self-assigned this Nov 29, 2024
@pimvenderbosch
Copy link
Member Author

Hi @RolandMacDoland and @Doomsk,

I've completed half of this PR, namely the updating of docstrings. Possibly a good idea to already review this part, so that the eventual review is not massive.

Best,
Pim

@RolandMacDoland RolandMacDoland changed the title Add contents to the docs [Docs] Add contents to the docs Dec 3, 2024
RolandMacDoland
RolandMacDoland approved these changes Dec 3, 2024
View reviewed changes
Copy link
Contributor

@RolandMacDoland RolandMacDoland left a comment

Choose a reason for hiding this comment

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

LGTM. Minor quibbles.

qadence2_ir/irast.py Show resolved Hide resolved
qadence2_ir/irast.py Outdated Show resolved Hide resolved
qadence2_ir/types.py Outdated Show resolved Hide resolved
Doomsk
Doomsk requested changes Dec 5, 2024
View reviewed changes
Copy link
Member

@Doomsk Doomsk left a comment

Choose a reason for hiding this comment

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

Thanks for the great work. There are a few comments to improve the documentation

Doomsk
Doomsk requested changes Dec 5, 2024
View reviewed changes
Copy link
Member

@Doomsk Doomsk left a comment

Choose a reason for hiding this comment

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

Great work! A few comments and I think that's it

docs/contents/challenges.md Outdated Show resolved Hide resolved
docs/contents/challenges.md Outdated Show resolved Hide resolved
docs/examples.md Outdated Show resolved Hide resolved
@pimvenderbosch
Copy link
Member Author

Created #22 with ideas of improving the documentation at a later stage.

@pimvenderbosch pimvenderbosch marked this pull request as ready for review December 9, 2024 13:00
@pimvenderbosch pimvenderbosch merged commit b600f7f into main Dec 9, 2024
7 checks passed
@pimvenderbosch pimvenderbosch deleted the pv/docs-contents branch December 9, 2024 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Doomsk Doomsk Doomsk approved these changes

@RolandMacDoland RolandMacDoland RolandMacDoland approved these changes

Assignees

@pimvenderbosch pimvenderbosch

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@pimvenderbosch @RolandMacDoland @Doomsk @kaosmicadei