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

Lint and format docs #136

Merged
merged 3 commits into from
Mar 7, 2024
Merged

Lint and format docs #136

merged 3 commits into from
Mar 7, 2024

Conversation

pavithraes
Copy link
Contributor

Fixes #135

@pavithraes pavithraes requested a review from melissawm March 6, 2024 17:05
timkpaine
timkpaine requested changes Mar 6, 2024
View reviewed changes
Copy link
Member

@timkpaine timkpaine left a comment

Choose a reason for hiding this comment

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

Can you edit the commit message from Re-push updates with signed commits to something descriptive of the change itself, e.g. Add docs linting/fixing.

Makefile Outdated Show resolved Hide resolved
@pavithraes
Add and run lint+format tools on docs pages
d602e1a 
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@pavithraes
Use separate lint and fix commands
52e3fa0 
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@pavithraes
Copy link
Contributor Author

Thanks for the review, I've made the necessary updates :)

@pavithraes pavithraes requested a review from timkpaine March 6, 2024 19:13
timkpaine
timkpaine previously requested changes Mar 6, 2024
View reviewed changes
pyproject.toml Show resolved Hide resolved
@timkpaine timkpaine added the part: documentation Improvements/bugs/changes to documentation label Mar 6, 2024
@ngoldbaum
Copy link
Contributor

It doesn’t exist already but it might be nice to have a linting subsection in the dev guide, explaining what is linted with what tools and with a pointer toward make fix.

@timkpaine
Copy link
Member

timkpaine commented Mar 6, 2024 •
edited
Loading

It doesn’t exist already but it might be nice to have a linting subsection in the dev guide, explaining what is linted with what tools and with a pointer toward make fix.

We can add more to the existing lint and fix section

@ngoldbaum
Copy link
Contributor

Oops, forgot that was in the build instructions.

@timkpaine
Copy link
Member

Also the contributing guidelines should be moved to the 99 developer page as they include required information (like e.g. closing PRs with non-substantive changes or without prior discussion for big features). But we can do in a followup PR to avoid conflicts

@timkpaine timkpaine dismissed their stale review March 6, 2024 22:03

will do in followup

timkpaine
timkpaine previously approved these changes Mar 6, 2024
View reviewed changes
Copy link
Member

@timkpaine timkpaine left a comment •
edited
Loading

Choose a reason for hiding this comment

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

3 followup changes:

  • Add these 2 new deps to conda yaml
  • Move contributing guidelines from 98 to 99
  • Expand 98 linting/fixing docs and link from 99

@timkpaine
add docs linting deps to conda, move important info about dco/lints/t…
f75e1e0 
…ests/acceptable contributions from 98 to 99, add docs linting section to 98

Signed-off-by: Tim Paine <timothy.paine@cubistsystematic.com>
@timkpaine timkpaine requested a review from ngoldbaum March 7, 2024 12:44
@ngoldbaum ngoldbaum merged commit e6f2be3 into main Mar 7, 2024
15 checks passed
@ngoldbaum ngoldbaum deleted the pavithraes/lint branch March 7, 2024 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ngoldbaum ngoldbaum ngoldbaum approved these changes

@timkpaine timkpaine timkpaine left review comments

@melissawm melissawm Awaiting requested review from melissawm

Assignees
No one assigned
Labels
part: documentation Improvements/bugs/changes to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Lint and format docs
3 participants
@pavithraes @ngoldbaum @timkpaine