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

RFC0009 - Documentation comments #102

Merged
merged 20 commits into from
Dec 20, 2022
Merged

RFC0009 - Documentation comments #102

merged 20 commits into from
Dec 20, 2022

Conversation

Binto86
Copy link
Contributor

@Binto86 Binto86 commented Oct 30, 2022

Specified documentation comments.

@Binto86 Binto86 changed the title Documentation comments RFC0009 - Documentation comments Oct 30, 2022
LPeter1997
LPeter1997 reviewed Oct 31, 2022
View reviewed changes
Specification/Comments.md Outdated Show resolved Hide resolved
Specification/Comments.md Outdated Show resolved Hide resolved
Specification/Comments.md Outdated Show resolved Hide resolved
Specification/Comments.md Outdated Show resolved Hide resolved
Kuinox
Kuinox reviewed Nov 3, 2022
View reviewed changes
Specification/Comments.md Outdated Show resolved Hide resolved
Specification/Comments.md Outdated Show resolved Hide resolved
LPeter1997
LPeter1997 reviewed Nov 7, 2022
View reviewed changes
Specification/Comments.md Outdated Show resolved Hide resolved
Specification/Comments.md Outdated Show resolved Hide resolved
@Kuinox
Copy link
Member

Kuinox commented Nov 7, 2022

I have an issue with the structure of the documentation.
I'd prefer if we splitted "regular" comments (we should drop the regular part), and documentation comment.
Documentation comments are comments, therefor I recommend that we split the specs in two.

A spec for the comments, and a separated spec (so separated file) for the documentation comments, specifying that documentation comments are a subset of comments.

I also recommend to inspirate heavily the structure of their specs:
https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/lexical-structure#633-comments
It's easy to read, and you understand easily. The c# documentation comments specs is the opposite.

LPeter1997
LPeter1997 reviewed Dec 5, 2022
View reviewed changes
Specification/Comments.md Outdated Show resolved Hide resolved
Specification/Comments.md Outdated Show resolved Hide resolved
Specification/Comments.md Show resolved Hide resolved
Binto86 and others added 3 commits December 5, 2022 18:58
Kuinox
Kuinox reviewed Dec 5, 2022
View reviewed changes
Specification/Comments.md Show resolved Hide resolved
Specification/Comments.md Outdated Show resolved Hide resolved
Specification/Comments.md Outdated Show resolved Hide resolved
Specification/Comments.md Show resolved Hide resolved
Specification/Comments.md Outdated Show resolved Hide resolved
LPeter1997
LPeter1997 approved these changes Dec 11, 2022
View reviewed changes
Specification/Comments.md Outdated Show resolved Hide resolved
@LPeter1997 LPeter1997 merged commit cedbe7b into Draco-lang:main Dec 20, 2022
LPeter1997 added a commit that referenced this pull request Mar 25, 2023
@Binto86 @LPeter1997 @lucyelle
Module system (#110)
e5eed9d 
* Create Module

Definition of module and exporting symbols

* Importing symbols

* Rename Modules.md to Module system.md

* Rename Module system.md to ModuleSystem.md

* Some rephrasing

* Rephrased and extended definition of module.

* Update ModuleSystem.md

* Extended explonation

* Added big example

* Update ModuleSystem.md

* Update ModuleSystem.md

* Update ModuleSystem.md

* Update ModuleSystem.md

* Update ModuleSystem.md

* Update ModuleSystem.md

* RFC0009 - Documentation comments (#102)

* Added documentation comments

* Update Comments.md

* fixed a typo

* Defined linking to symbols

* Update Comments.md

* Update Comments.md

* Fixed a typo

* Fixed a typo

* Update Comments.md

* Update Comments.md

* Update Comments.md

* Update Specification/Comments.md

Co-authored-by: LPeter1997 <lenkefi.peti@gmail.com>

* Update Comments.md

* Update Comments.md

* Update Comments.md

* Update Comments.md

* Update Comments.md

Co-authored-by: LPeter1997 <lenkefi.peti@gmail.com>

* Update FeatureTracking.md (#108)

* Minor fixes (#109)

Co-authored-by: lucyelle <lucyelle@users.noreply.github.com>

* Update ModuleSystem.md

* Create Overloading.md (#111)

* Update ModuleSystem.md

---------

Co-authored-by: LPeter1997 <lenkefi.peti@gmail.com>
Co-authored-by: lucyelle <35396043+lucyelle@users.noreply.github.com>
Co-authored-by: lucyelle <lucyelle@users.noreply.github.com>
LPeter1997 added a commit that referenced this pull request Apr 21, 2023
@Binto86 @LPeter1997 @lucyelle
RFC0011 - Module System (#112)
f247b54 
* RFC0008 - Module system (#101)

* Create Module

Definition of module and exporting symbols

* Importing symbols

* Rename Modules.md to Module system.md

* Rename Module system.md to ModuleSystem.md

* Some rephrasing

* Rephrased and extended definition of module.

* Update ModuleSystem.md

* Extended explonation

* Added big example

* Update ModuleSystem.md

* Update ModuleSystem.md

* Update ModuleSystem.md

* Update ModuleSystem.md

* Update ModuleSystem.md

* Update ModuleSystem.md

* Module system (#110)

* Create Module

Definition of module and exporting symbols

* Importing symbols

* Rename Modules.md to Module system.md

* Rename Module system.md to ModuleSystem.md

* Some rephrasing

* Rephrased and extended definition of module.

* Update ModuleSystem.md

* Extended explonation

* Added big example

* Update ModuleSystem.md

* Update ModuleSystem.md

* Update ModuleSystem.md

* Update ModuleSystem.md

* Update ModuleSystem.md

* Update ModuleSystem.md

* RFC0009 - Documentation comments (#102)

* Added documentation comments

* Update Comments.md

* fixed a typo

* Defined linking to symbols

* Update Comments.md

* Update Comments.md

* Fixed a typo

* Fixed a typo

* Update Comments.md

* Update Comments.md

* Update Comments.md

* Update Specification/Comments.md

Co-authored-by: LPeter1997 <lenkefi.peti@gmail.com>

* Update Comments.md

* Update Comments.md

* Update Comments.md

* Update Comments.md

* Update Comments.md

Co-authored-by: LPeter1997 <lenkefi.peti@gmail.com>

* Update FeatureTracking.md (#108)

* Minor fixes (#109)

Co-authored-by: lucyelle <lucyelle@users.noreply.github.com>

* Update ModuleSystem.md

* Create Overloading.md (#111)

* Update ModuleSystem.md

---------

Co-authored-by: LPeter1997 <lenkefi.peti@gmail.com>
Co-authored-by: lucyelle <35396043+lucyelle@users.noreply.github.com>
Co-authored-by: lucyelle <lucyelle@users.noreply.github.com>

* Update Specification/ModuleSystem.md

Co-authored-by: LPeter1997 <lenkefi.peti@gmail.com>

* Update Specification/ModuleSystem.md

Co-authored-by: LPeter1997 <lenkefi.peti@gmail.com>

* Update ModuleSystem.md

* Remove private keyword

* Update ModuleSystem.md

* Update definition of imports

* Update Specification/ModuleSystem.md

Co-authored-by: LPeter1997 <lenkefi.peti@gmail.com>

* Update Specification/ModuleSystem.md

Co-authored-by: LPeter1997 <lenkefi.peti@gmail.com>

* Update Specification/ModuleSystem.md

Co-authored-by: LPeter1997 <lenkefi.peti@gmail.com>

* Update Specification/ModuleSystem.md

Co-authored-by: LPeter1997 <lenkefi.peti@gmail.com>

* Update ModuleSystem.md

* Update ModuleSystem.md

* Update ModuleSystem.md

* Update ModuleSystem.md

* Pi is now 3

---------

Co-authored-by: LPeter1997 <lenkefi.peti@gmail.com>
Co-authored-by: lucyelle <35396043+lucyelle@users.noreply.github.com>
Co-authored-by: lucyelle <lucyelle@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Kuinox Kuinox Kuinox left review comments

@LPeter1997 LPeter1997 LPeter1997 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Binto86 @Kuinox @LPeter1997