Skip to content

Modify documentation #399

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
Merged
merged 26 commits into from
Jan 30, 2024
Merged

Modify documentation #399

merged 26 commits into from
Jan 30, 2024

Conversation

@dipinknair
Copy link
Contributor

@dipinknair dipinknair commented Jan 19, 2024 •
edited
Loading

  • Remove redundant code blocks
  • Fix references
  • Updates example file
  • Fix vale error

Related #398

@dipinknair dipinknair added documentation Improvements or additions to documentation maintenance Package and maintenance related labels Jan 19, 2024
@dipinknair dipinknair self-assigned this Jan 19, 2024
@dipinknair dipinknair linked an issue Jan 19, 2024 that may be closed by this pull request
Modify Pages "How to" and "Styles" #398
Closed
3 tasks
MaxJPRey
MaxJPRey reviewed Jan 20, 2024
View reviewed changes
@dipinknair dipinknair marked this pull request as draft January 20, 2024 20:45
dipinknair and others added 2 commits January 20, 2024 19:05
@dipinknair
- python version correction
421462e 
- image size
- checklist modification
- table modification
@dipinknair @MaxJPRey
Update doc/source/how-to/setting-up.rst
9fb3dff 
Review feedback

Co-authored-by: Maxime Rey <87315832+MaxJPRey@users.noreply.github.com>
@dipinknair dipinknair mentioned this pull request Jan 21, 2024
Closed
3 tasks
@dipinknair dipinknair marked this pull request as ready for review January 22, 2024 05:41
RobPasMue
RobPasMue approved these changes Jan 22, 2024
View reviewed changes
Copy link
Member

@RobPasMue RobPasMue left a comment

Choose a reason for hiding this comment

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

Requested changes - otherwise LGTM!

PipKat
PipKat reviewed Jan 22, 2024
View reviewed changes
PipKat
PipKat reviewed Jan 22, 2024
View reviewed changes
PipKat
PipKat reviewed Jan 22, 2024
View reviewed changes
PipKat
PipKat reviewed Jan 22, 2024
View reviewed changes
PipKat
PipKat reviewed Jan 22, 2024
View reviewed changes
PipKat
PipKat reviewed Jan 22, 2024
View reviewed changes
PipKat
PipKat reviewed Jan 22, 2024
View reviewed changes
PipKat
PipKat reviewed Jan 22, 2024
View reviewed changes
PipKat
PipKat reviewed Jan 22, 2024
View reviewed changes
PipKat
PipKat reviewed Jan 22, 2024
View reviewed changes
PipKat
PipKat reviewed Jan 22, 2024
View reviewed changes
PipKat
PipKat reviewed Jan 22, 2024
View reviewed changes
PipKat
PipKat reviewed Jan 22, 2024
View reviewed changes
PipKat
PipKat reviewed Jan 22, 2024
View reviewed changes
PipKat
PipKat reviewed Jan 22, 2024
View reviewed changes
PipKat
PipKat reviewed Jan 22, 2024
View reviewed changes
PipKat
PipKat reviewed Jan 22, 2024
View reviewed changes
PipKat
PipKat reviewed Jan 22, 2024
View reviewed changes
PipKat
PipKat reviewed Jan 22, 2024
View reviewed changes
dipinknair and others added 8 commits January 23, 2024 11:13
@dipinknair @PipKat
Apply suggestions from code review
5b0ba95 
Feedback from @PipKat

Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@dipinknair @PipKat
Update doc/source/how-to/logging.rst
a7c7b29 
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@dipinknair @PipKat
Update doc/source/how-to/setting-up.rst
b25609a 
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@dipinknair @PipKat
Update doc/source/how-to/setting-up.rst
31014c8 
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@dipinknair @PipKat
Update doc/source/how-to/setting-up.rst
ef17fbc 
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@dipinknair @PipKat
Update doc/source/how-to/setting-up.rst
7d30911 
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@dipinknair @PipKat
Update doc/source/how-to/setting-up.rst
cc24298 
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@dipinknair @PipKat
Update doc/source/how-to/setting-up.rst
c20a7a5 
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@dipinknair
Copy link
Contributor Author

dipinknair commented Jan 23, 2024

Thank you @PipKat for the review and suggestions.

@dipinknair dipinknair requested a review from PipKat January 23, 2024 17:22
@RobPasMue
Copy link
Member

RobPasMue commented Jan 29, 2024

@dipinknair - try and have a look at the failing workflows

@dipinknair dipinknair requested a review from RobPasMue January 29, 2024 18:39
@dipinknair dipinknair merged commit 5353358 into main Jan 30, 2024
@dipinknair dipinknair deleted the doc/fix-how-to branch January 30, 2024 11:03
github-actions bot pushed a commit that referenced this pull request Jan 30, 2024
@dipinknair @MaxJPRey
@PipKat @RobPasMue
Modify documentation (#399)
f951194 
* Removing redundant code blocks

* remove sg_execution_times gitignore

* - python version correction

- image size
- checklist modification
- table modification

* Update doc/source/how-to/setting-up.rst

Review feedback

Co-authored-by: Maxime Rey <87315832+MaxJPRey@users.noreply.github.com>

* Adjust specing of lines

* update python supporting versions

* Apply suggestions from code review

Review from @PipKat

Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>

* Update doc/source/doc-style/formatting-tools.rst

Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>

* Update doc/source/coding-style/formatting-tools.rst

Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>

* Update doc/source/doc-style/formatting-tools.rst

Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>

* Apply suggestions from code review

Feedback from @PipKat

Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>

* Update doc/source/how-to/logging.rst

Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>

* Update doc/source/how-to/setting-up.rst

Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>

* Update doc/source/how-to/setting-up.rst

Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>

* Update doc/source/how-to/setting-up.rst

Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>

* Update doc/source/how-to/setting-up.rst

Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>

* Update doc/source/how-to/setting-up.rst

Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>

* Update doc/source/how-to/setting-up.rst

Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>

* vale check

* vale feedback

---------

Co-authored-by: Maxime Rey <87315832+MaxJPRey@users.noreply.github.com>
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@MaxJPRey MaxJPRey Awaiting requested review from MaxJPRey

@jorgepiloto jorgepiloto Awaiting requested review from jorgepiloto

@PipKat PipKat Awaiting requested review from PipKat

@RobPasMue RobPasMue Awaiting requested review from RobPasMue

Assignees

@dipinknair dipinknair

Labels

documentation Improvements or additions to documentation maintenance Package and maintenance related

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Modify Pages "How to" and "Styles"

5 participants

@dipinknair @RobPasMue @PipKat @MaxJPRey