Skip to content
This repository has been archived by the owner on Sep 6, 2021. It is now read-only.

update elixir syntax #65

Merged
merged 5 commits into from Oct 16, 2019
Merged

update elixir syntax #65

merged 5 commits into from Oct 16, 2019

Conversation

techgaun
Copy link
Contributor

update elixir's syntax so that it does not use module attributes.. as discussed in apidoc/apidoc#640 and issue referenced in that issue (https://github.com/rrrene/credo/issues/291), we need to use alternative instead of the module attribute for describing api documentation. Some of us put warnings as errors and unused module attributes produce compiler warnings.

@windhamwong
Copy link

lol the doc has updated but it is not yet supported.

// Remove not needed tabs at the beginning
inlineRegExp: /^(\t*)?/gm
// Find document blocks between '#{' and '#}'
docBlocksRegExp: /\#*\{\uffff?(.+?)\uffff?(?:\s*)?\#+\}/g,

Choose a reason for hiding this comment

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

Elixir 1.6 formatter will insert a space between # and space (i.e. "#{" => "# {"), can we update the regex to allow a space and merge it?

* expect space

* Update ex.js

* Update ex.js

* Update ex.js
@techgaun
Copy link
Contributor Author

@jerryluk you could try my fork with the new change from @thiamsantos . I've tried to reach to the maintainer of apidoc but never heard back. I guess the original author is pretty busy with other stuff. If everyone in the community agrees, I would like to step up and maintain proper maintained fork (would be happy to merge back in the future if the original author becomes active again). I will spend next couple of weeks going through the codebase and issues and try to bring this in shape.

@sillypog
Copy link

I hadn't seen this until now, but I recently submitted a pull request that eliminates these warnings in a different way by allowing the apidocs to be wrapped in an @doc attribute. It preserves the original syntax and makes the existing inaccurate documentation correct. #75.

@NicolasCARPi
Copy link
Collaborator

Hello,

Thank you for your contribution! I'm hoping to make a new release once I've gone through all PR and most issues.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants