Skip to content

Use literate programming for JS API specs#3552

Merged
nex3 merged 1 commit intomainfrom
literate
Apr 27, 2023
Merged

Use literate programming for JS API specs#3552
nex3 merged 1 commit intomainfrom
literate

Conversation

@nex3
Copy link
Contributor

@nex3 nex3 commented Apr 20, 2023

No description provided.

@nex3 nex3 force-pushed the literate branch 4 times, most recently from 73b1f50 to 8b4a053 Compare April 25, 2023 00:21
@nex3 nex3 marked this pull request as ready for review April 25, 2023 01:58
@nex3 nex3 requested a review from jathak April 25, 2023 01:58
jathak
jathak approved these changes Apr 27, 2023
View reviewed changes
Copy link
Member

@jathak jathak left a comment

Choose a reason for hiding this comment

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

Is the plan to do something similar for the user-facing documentation in js-api-doc, or is that not feasible since we need the actual documentation to be in comments so it's accessible to TypeDoc?

@nex3
Copy link
Contributor Author

nex3 commented Apr 27, 2023

My plan is to leave js-api-doc as-is, for the reason you describe. It also follows a much more typical pattern of "documenting specific types" rather than the spec-style pattern of "specifying behavior which is sometimes but not always attached to types".

@nex3 nex3 merged commit 7abda4e into main Apr 27, 2023
@nex3 nex3 deleted the literate branch April 27, 2023 20:50
@jgerigmeyer
Copy link
Contributor

jgerigmeyer commented Apr 27, 2023

@nex3 I think this PR (specifically the removal of spec/js-api/index.d.ts) is breaking CI currently on dart-sass and sass-spec repos:

@nex3
Copy link
Contributor Author

nex3 commented Apr 27, 2023

Oops, forgot to land corresponding updates elsewhere. I bet it's also breaking sass-site.

@nex3 nex3 mentioned this pull request Apr 27, 2023
Merged
nex3 added a commit to sass/sass-spec that referenced this pull request Apr 27, 2023
@nex3
Run specs against the JS API doc typedefs
25290f1 
This fixes a breakage caused by moving the specs to a literate
programming style in sass/sass#3552.
nex3 added a commit to sass/sass-spec that referenced this pull request Apr 27, 2023
@nex3
Run specs against the JS API doc typedefs (#1904)
8c5087c 
This fixes a breakage caused by moving the specs to a literate
programming style in sass/sass#3552.
@nex3
Copy link
Contributor Author

nex3 commented Apr 27, 2023

@jgerigmeyer Should be fixed now, let me know if it's not.

@jgerigmeyer
Copy link
Contributor

jgerigmeyer commented Apr 28, 2023

@nex3 That worked -- thanks!

@Goodwine Goodwine mentioned this pull request May 9, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jathak jathak jathak 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

@nex3 @jgerigmeyer @jathak