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

[BUG] Documentation generated has issues with multiline comments #459

Closed
Mte90 opened this issue Sep 5, 2024 · 1 comment · Fixed by #464
Closed

[BUG] Documentation generated has issues with multiline comments #459

Mte90 opened this issue Sep 5, 2024 · 1 comment · Fixed by #464
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@Mte90
Copy link
Member

Mte90 commented Sep 5, 2024

Taking as example https://github.com/amber-lang/amber/blob/master/src/std/date.ab

Generate this markdown:

## `date_posix`


EXPERIMENTAL
Format a date with a special format
If no date is specified, the current date is used
If no format is specified, "%FT%T%Z" format is used
For more info about format type "man date" on your shell or go to https://www.gnu.org/software/coreutils/date
Format :
%%     a literal %
%a     locale's abbreviated weekday name (e.g., Sun)
%A     locale's full weekday name (e.g., Sunday)
%b     locale's abbreviated month name (e.g., Jan)
%B     locale's full month name (e.g., January)
%c     locale's date and time (e.g., Thu Mar  3 23:05:25 2005)
%C     century; like %Y, except omit last two digits (e.g., 20)
%d     day of month (e.g., 01)
%D     date; same as %m/%d/%y
%e     day of month, space padded; same as %_d
%F     full date; like %+4Y-%m-%d
%g     last two digits of year of ISO week number (see %G)
%G     year of ISO week number (see %V); normally useful only with %V
%h     same as %b
%H     hour (00..23)
%I     hour (01..12)
%j     day of year (001..366)
%k     hour, space padded ( 0..23); same as %_H
%l     hour, space padded ( 1..12); same as %_I
%m     month (01..12)
%M     minute (00..59)
%n     a newline
%N     nanoseconds (000000000..999999999)
%p     locale's equivalent of either AM or PM; blank if not known
%P     like %p, but lower case
%q     quarter of year (1..4)
%r     locale's 12-hour clock time (e.g., 11:11:04 PM)
%R     24-hour hour and minute; same as %H:%M
%s     seconds since the Epoch (1970-01-01 00:00 UTC)
%S     second (00..60)
%t     a tab
%T     time; same as %H:%M:%S
%u     day of week (1..7); 1 is Monday
%U     week number of year, with Sunday as first day of week (00..53)
%V     ISO week number, with Monday as first day of week (01..53)
%w     day of week (0..6); 0 is Sunday
%W     week number of year, with Monday as first day of week (00..53)
%x     locale's date representation (e.g., 12/31/99)
%X     locale's time representation (e.g., 23:13:48)
%y     last two digits of year (00..99)
%Y     year
%z     +hhmm numeric time zone (e.g., -0400)
%:z    +hh:mm numeric time zone (e.g., -04:00)
%::z   +hh:mm:ss numeric time zone (e.g., -04:00:00)
%:::z  numeric time zone with : to necessary precision (e.g., -04, +05:30)
%Z     alphabetic time zone abbreviation (e.g., EDT)

By default, date pads numeric fields with zeroes.  The following optional flags may follow '%':

-      (hyphen) do not pad the field
_      (underscore) pad with spaces
0      (zero) pad with zeros
+      pad with zeros, and put '+' before future years with >4 digits
^      use upper case if possible
#      use opposite case if possible


## `now`


Return current timestamp (seconds since the Epoch (1970-01-01 00:00 UTC))


## `date_add`


EXPERIMENTAL
Add value to date.
If no date is specified, the current date is used
Ex : date_add("+3 days")
You can use :
(+/-)
years
months
days
hours
minutes
seconds


EXPERIMENTAL


Compare 2 date

Return 1 if date_a is after date_b

Return 0 if date_a and date_b is the same

Return -1 if date_b is after date_a

If date_b is not provided, current date will be used

## `date_compare`

When markdown is converted to hthml are missing the newlines.

image

Also in the date_compare the documentation position is wrong so that function doesn't have the documentation that instead is placed on the function above.

@Mte90
Copy link
Member Author

Mte90 commented Sep 6, 2024

I think that the issue is there

https://github.com/amber-lang/amber/blob/master/src/modules/statement/comment_doc.rs#L28

If the next line is a comment it should add " " a couple of empty spaces.
Next we can see how to implement the support on the website to support the double ending space as newline. (amber-lang/amber-docs#39)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants