Skip to content

Conversation

@TomStrepsil
Copy link
Contributor

@TomStrepsil TomStrepsil commented Dec 26, 2024

Issue

18

Details

Rename all instances of asos-web-toggle-point or toggle-point to web-toggle-point in the JSDoc comments.

Also

  • fix up the title in the main README.md to match the naming of "Web Toggle Point"
  • fix up CHANGELOG.md entry for re-imagined version history.
  • fix broken link in CHANGELOG.md
  • remove sdkInstanceProvider signature from JSDoc external.js, no longer a thing after extraction of Optimizely package
  • fixup dedupeExternalJsdocPlugin, a change in 0.5.0 has regressed, believe to be after move to a typescript-savvy imported typedef.

CheckList

  • PR starts with [ISSUE_ID].
  • Has been tested (where required) before merge to main.

@TomStrepsil TomStrepsil changed the title Docs/fixup jsdoc module names Fix JSDoc module names Dec 26, 2024
@TomStrepsil TomStrepsil requested a review from Copilot December 26, 2024 13:29
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 8 out of 23 changed files in this pull request and generated no comments.

Files not reviewed (15)
  • packages/features/package.json: Language not supported
  • packages/react-pointcuts/package.json: Language not supported
  • packages/ssr/package.json: Language not supported
  • packages/ssr/docs/CHANGELOG.md: Evaluated as low risk
  • packages/react-pointcuts/docs/CHANGELOG.md: Evaluated as low risk
  • packages/react-pointcuts/docs/README.md: Evaluated as low risk
  • packages/react-pointcuts/src/getCodeSelectionPlugins.js: Evaluated as low risk
  • packages/features/src/reactContext/store.js: Evaluated as low risk
  • packages/features/src/ssrBackedReactContext/store.js: Evaluated as low risk
  • packages/react-pointcuts/src/withTogglePointFactory/index.js: Evaluated as low risk
  • packages/react-pointcuts/src/withToggledHookFactory/index.js: Evaluated as low risk
  • packages/features/src/global/store.js: Evaluated as low risk
  • packages/features/src/nodeRequestScoped/store.js: Evaluated as low risk
  • packages/ssr/src/withJsonIsomorphism/index.js: Evaluated as low risk
  • packages/features/src/global.js: Evaluated as low risk

@TomStrepsil TomStrepsil requested a review from Copilot December 26, 2024 13:32
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 11 out of 26 changed files in this pull request and generated no comments.

Files not reviewed (15)
  • package.json: Language not supported
  • packages/features/package.json: Language not supported
  • packages/react-pointcuts/package.json: Language not supported
  • packages/ssr/package.json: Language not supported
  • docs/CHANGELOG.md: Evaluated as low risk
  • docs/README.md: Evaluated as low risk
  • packages/features/docs/CHANGELOG.md: Evaluated as low risk
  • packages/features/docs/README.md: Evaluated as low risk
  • packages/features/src/global.js: Evaluated as low risk
  • packages/features/src/global/store.js: Evaluated as low risk
  • packages/features/src/nodeRequestScoped/store.js: Evaluated as low risk
  • packages/features/src/reactContext/store.js: Evaluated as low risk
  • packages/react-pointcuts/src/withToggledHookFactory/index.js: Evaluated as low risk
  • packages/react-pointcuts/src/withTogglePointFactory/index.js: Evaluated as low risk
  • packages/features/src/ssrBackedReactContext/store.js: Evaluated as low risk

@TomStrepsil TomStrepsil added the documentation Improvements or additions to documentation label Dec 26, 2024
@TomStrepsil TomStrepsil changed the title Fix JSDoc module names [#18] Fix JSDoc module names Dec 27, 2024
Copy link

@asos-dominicjomaa asos-dominicjomaa left a comment

Choose a reason for hiding this comment

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

lgtm ghost Tom

@asos-danielc asos-danielc merged commit ace94de into main Jan 30, 2025
11 checks passed
@asos-danielc asos-danielc deleted the docs/fixup-jsdoc-module-names branch January 30, 2025 15:30
@TomStrepsil TomStrepsil changed the title [#18] Fix JSDoc module names [18] Fix JSDoc module names Mar 21, 2025
TomStrepsil added a commit to TomStrepsil/web-toggle-point that referenced this pull request Apr 10, 2025
* rename to proper module namespace

* update docs links

* update versions

* web toggle point in readme title

* fixup changelog from revised 0.x range

* 2.0.0 -> 0.5.0 in oss version scheme

* fix broken link syntax in CHANGELOG

* consistent quoting

* more version history issues

* fixup module name in jsdoc

* add web
remove sdkInstanceProvider

* remove SDKInstanceProvider

* fixup jsdoc dedupe

* tweak

* clarity re: ssr package

* casing etc
asos-dominicjomaa pushed a commit that referenced this pull request Jul 14, 2025
* [#18] Fix JSDoc module names (#19)
* [26] Fix public/scoped package publishing (#27)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants