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

Add necessary first line in proto file examples #5692

Merged
merged 4 commits into from
Dec 23, 2022

Conversation

stepkun
Copy link
Contributor

@stepkun stepkun commented Dec 23, 2022

Description
For a newbie it is not easy to find that the first line in a proto file has to be #VRML_SIM R2023a utf8.

Documentation
Current page is https://cyberbotics.com/doc/guide/tutorial-7-your-first-proto
Modified page is https://cyberbotics.com/doc/guide/tutorial-7-your-first-proto?version=stepkun:patch-1

@stepkun stepkun requested a review from a team as a code owner December 23, 2022 11:40
@BenjaminDeleze BenjaminDeleze added the documentation Improve or fix the documentation (MD files only, no software development) label Dec 23, 2022
@BenjaminDeleze BenjaminDeleze added this to the R2023a-rev1 milestone Dec 23, 2022
Copy link
Member

@omichel omichel left a comment

Choose a reason for hiding this comment

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

Thank you for this contribution!
However, in order to be more scalable when we release a new version, it is better to use the suggested macro.

docs/guide/tutorial-7-your-first-proto.md Outdated Show resolved Hide resolved
docs/guide/tutorial-7-your-first-proto.md Outdated Show resolved Hide resolved
docs/guide/tutorial-7-your-first-proto.md Outdated Show resolved Hide resolved
Copy link
Contributor Author

@stepkun stepkun left a comment

Choose a reason for hiding this comment

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

Much better to use macro

@stepkun stepkun requested a review from omichel December 23, 2022 13:34
Copy link
Member

@omichel omichel left a comment

Choose a reason for hiding this comment

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

Thank you.

@omichel
Copy link
Member

omichel commented Dec 23, 2022

@stepkun: feel free to press the "Squash and merge" green button now 😄.

@stepkun stepkun merged commit b9b03d7 into cyberbotics:released Dec 23, 2022
ad-daniel pushed a commit that referenced this pull request Dec 24, 2022
* Add a troubleshooting section for macOS installation with respect to Rosetta (#5691)

* Update installation-procedure.md

* Update installation-procedure.md

* Add files via upload

* Add necessary first line in proto file examples (#5692)

* Add necessary first line in proto file examples

* Update docs/guide/tutorial-7-your-first-proto.md

Co-authored-by: Olivier Michel <[email protected]>

* Update docs/guide/tutorial-7-your-first-proto.md

Co-authored-by: Olivier Michel <[email protected]>

* Update docs/guide/tutorial-7-your-first-proto.md

Co-authored-by: Olivier Michel <[email protected]>

Co-authored-by: Olivier Michel <[email protected]>

Co-authored-by: Olivier Michel <[email protected]>
Co-authored-by: Stephan Kunz <[email protected]>
ygoumaz added a commit that referenced this pull request Dec 26, 2022
* Fix infinite loop updating ODE geometries (#5686)

* Skip updates if geometry is going to be deleted

* Fix dangling ODE geometries

* Update changelog

* remove libcontroller sync in test suite (#5689)

Co-authored-by: Olivier Michel <[email protected]>

* Merge released into master (#5696)

* Add a troubleshooting section for macOS installation with respect to Rosetta (#5691)

* Update installation-procedure.md

* Update installation-procedure.md

* Add files via upload

* Add necessary first line in proto file examples (#5692)

* Add necessary first line in proto file examples

* Update docs/guide/tutorial-7-your-first-proto.md

Co-authored-by: Olivier Michel <[email protected]>

* Update docs/guide/tutorial-7-your-first-proto.md

Co-authored-by: Olivier Michel <[email protected]>

* Update docs/guide/tutorial-7-your-first-proto.md

Co-authored-by: Olivier Michel <[email protected]>

Co-authored-by: Olivier Michel <[email protected]>

Co-authored-by: Olivier Michel <[email protected]>
Co-authored-by: Stephan Kunz <[email protected]>

Co-authored-by: Stefania Pedrazzi <[email protected]>
Co-authored-by: Yannick Goumaz <[email protected]>
Co-authored-by: Olivier Michel <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Stephan Kunz <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improve or fix the documentation (MD files only, no software development)
Development

Successfully merging this pull request may close these issues.

3 participants